-
Notifications
You must be signed in to change notification settings - Fork 13
/
Copy pathserve_table.Rd
57 lines (54 loc) · 1.72 KB
/
serve_table.Rd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/serve.R
\name{serve_table}
\alias{serve_table}
\title{Serve edibble table}
\usage{
serve_table(
.edibble = NULL,
label_nested = NULL,
fail = c("error", "warn", "ignore"),
.record = TRUE
)
}
\arguments{
\item{.edibble}{An edibble design (\code{edbl_design}), an edibble data frame (\code{edbl_table}) or an
object that contains the edibble data frame in the attribute
\code{design}.}
\item{label_nested}{The columns to show nested labels (if available). Tidyselect compatible.}
\item{fail}{What to do when failing to convert graph to table.}
\item{.record}{A logical value. This indicates whether to record this
code step. The default is TRUE. It should remain TRUE unless this
function is used as a wrapper in other code.}
}
\value{
An \code{edbl} data frame with columns defined by vertices and
rows displayed only if the vertices are connected and reconcile for output.
}
\description{
This converts an edibble graph object to a data frame called edibble.
This function should be used when the design is in the final form
(or close to the final form). The table can only be formed when the
variables can be reconciled, otherwise it will be a data frame with
zero rows.
}
\examples{
design("Completely Randomised Design") \%>\%
set_units(unit = 28) \%>\%
set_trts(trt = 6) \%>\%
allot_trts(trt ~ unit) \%>\%
assign_trts("random", seed = 521) \%>\%
serve_table()
}
\seealso{
Other user-facing functions:
\code{\link{allot_trts}()},
\code{\link{allot_units}()},
\code{\link{design}()},
\code{\link{expect_rcrds}()},
\code{\link{export_design}()},
\code{\link{set_rcrds}()},
\code{\link{set_trts}()},
\code{\link{set_units}()}
}
\concept{user-facing functions}