Learn R Programming

cohortBuilder (version 0.3.0)

description: Show source data or filter description

Description

If defined allows to check the provided description related to source data or configured filters.

Usage

description(
  x,
  field,
  step_id,
  filter_id,
  modifier = getOption("cb_help_modifier", default = function(x) x)
)

Value

Any object (or its subset) attached to Source of filter via description argument.

Arguments

x

Cohort object.

field

Name of the source description field provided as `description` argument to set_source. If missing, `step_id` and `filter_id` are used to return filter description.

step_id

Id of the filter step to return description of.

filter_id

Id of the filter to return description of.

modifier

A function taking the description as argument. The function can be used to modify its argument (convert to html, display in browser etc.).

See Also

cohort-methods