The code of a report's content, from its spec file

Writes the program a report's content: stands for – for a table, the table_plan() pipeline: one line an item, in the items' order, with their arguments as R takes them (!r as code, {fn:, args:} as the call it names, maps and sequences as the vectors and lists each argument takes; tfl_schema()). An item the report takes from the study's defaults or a pattern says so in a comment above it. The output is the report after its extends are applied (tfl_resolve_output()), so no !unset is left.

Usage

tfl_content_code(
  output,
  data = NULL,
  plan = "plan",
  pipe = NULL,
  template = c("call", "items")
)

Arguments

output: A report (tfl_output()), resolved.
data: The name of the object the pipe starts from; NULL: the output's data$object, else ard when the content normalizes it (a normalize_ard() item), else data. With data.steps (R that makes data from the output's object, the old process_code), the steps come first, as they are written, and the pipe starts from data.
plan: The name the plan is assigned to.
pipe: "|>" or "%>%"; NULL follows getOption("rtfreporter.ard_pipe").
template: For a resolved template report (template: {name, args}, tfl_resolve_output()): "call" (default) writes the template's call, plan <- tpl_<name>(ard, ...) with the arguments its SPEC gives and the study's defaults it took, then the study's and the report's own lines after it, each marked; "items" writes the items it stands for, as for any report (and so does "call", with a message, when the call cannot say the report's own table roles, data or normalization).

Value

The code, one element a line.

Details

A table's plan_levels() that says what its ARD already says is left out, here and in tfl_content_run(): a column's order that is the report's code list (applied when the ARD is made, a factor cards keeps in its order), and the variables in the order of the ARD's analyses. An order of the report's own, a column no analysis reads, a column an analysis that is not cards' reads (cardx's survfit names the arms from the strata) and a report whose data steps make its data keep theirs.

A report whose content is its own code (content: !r, any kind: the code leaves content) is that code, after the data's steps. A figure's content is its layers, as the figure designer has them (tfl_fig_design_code() of the design the report stands for: its data steps and statistics, the layers, its code lists): the figure in content, not saved.

Examples

out <- tfl_output("T-1", "table", content = list(
  tfl_item("table_plan", list(cols = "TRTA", rows = list(group = "variable"))),
  tfl_item("plan_cells", list(categorical = "{n} ({p:.1f%})")),
  tfl_item("plan_sort", list(keys = c("-n")), from = "defaults")))
cat(tfl_content_code(out), sep = "\n")
#> plan <- table_plan(data, cols = "TRTA", rows = c(group = "variable")) %>%
#>   plan_cells(categorical = "{n} ({p:.1f%})") %>%
#>   # (study default)
#>   plan_sort("-n")