Skip to contents

The arguments of every figure type, described

Source: R/fig_design.R
tfl_fig_schema.Rd

One row per argument of each figure type's tfl_fig_<type>() (and, for km, waterfall and swimmer, the axis and look options it takes through ...): what a figure design (tfl_fig_design()) may say, and what a GUI draws its form from.

Usage

tfl_fig_schema(type = NULL)

Arguments

type

A figure type (tfl_fig_types()); NULL for all.

Value

A data frame: type, fun, arg, section, kind, level, label, help, of, default, choices.

Details

  • section: data, mapping (the variables), style, axes, legend or output;

  • kind: dataset, param (a PARAMCD of the dataset named in of), variable / variables / flag (of of), value, choice, number, logical, text, expr (R code), named (label = variable pairs);

  • level: basic (shown first) or advanced;

  • default: the function's default, as text (NA = none / computed);

  • choices: for choice, the values, | between them.