fx_info_title: Build up a variable title

In sflippl/tectr: User Interface for Complex Datasets

Description

This function builds a title from a name and possibly certain statistics and units.

Usage

fx_info_title(data, name, ..., fxInfo_title = NULL,
  fxInfo_title_fun = NULL, fxInfo_name, fxInfo_unit = NULL,
  fxInfo_title_stats = character(0), fxInfo_title_na.show = NULL,
  fxInfo_title_na.show.threshold = 1L, fxInfo_title_n.show = FALSE,
  fxInfo_title_unit.show = FALSE)

Arguments

data	a data frame, possibly with metaframe
name	the internal name of the variable
fxInfo_title	either a title or NULL. If it is not NULL, all other parameters are irrelevant.
fxInfo_title_fun	either a function which determines a title or NULL. If it is not NULL, all parameters below are irrelevant.
fxInfo_name	the name of the variable
fxInfo_unit	the unit of the variable or NULL
fxInfo_title_stats	the statistics that should be given in the title. Number of data points and missing values are given separately.
fxInfo_title_na.show	Should the number of missing values be displayed?
fxInfo_title_na.show.threshold	If fxInfo_title_na.show is missing, what is the threshold number of missing values to display them. Default is 1.
fxInfo_title_n.show	Should the number of data points be displayed. Default is FALSE
fxInfo_title_unit.show	Should the unit be displayed?

sflippl/tectr documentation built on May 6, 2019, 8:51 a.m.