A template parameter — tfl

One parameter of a template (tfl_template()): its name, default and what it is. A template has few, and none of them is the look (a font, a width, the rows a page): the study's styles and defaults say that.

Usage

tfl_param(name, default = NULL, required = FALSE, doc = NULL, study = NULL)

Arguments

name: The parameter's name.
default: Its default value; NULL for none.
required: TRUE when a report must give it.
doc: One line saying what it is.
study: Where a study's default for it is, "<verb>.<argument>" ("plan_cells.continuous"): the value of the study's defaults (and pattern) item, when the report's template SPEC does not give it. NULL: the template's own default only.

Value

A tfl_param.

Examples

tfl_param("population", "SAF", doc = "the analysis set's id")
#> $name
#> [1] "population"
#> 
#> $default
#> [1] "SAF"
#> 
#> $required
#> [1] FALSE
#> 
#> $doc
#> [1] "the analysis set's id"
#> 
#> $study
#> NULL
#> 
#> attr(,"class")
#> [1] "tfl_param"