Subsection: Subsection object

Description Usage Arguments Details References See Also Examples

View source: R/Subsection.R

Description

This function creates an object of class Subsection which can be added to an object of class PresentationModel.

Usage

1

Arguments

by

defines the parameter to create the subsection in the report.

Details

Objects of class Subsection are used in objects of class PresentationModel to define how the results will be presented in the report. If a Subsection object is added to a PresentationModel object, the report will have subsections according to the parameter defined in the by argument. A single object of class Subsection can be added to an object of class PresentationModel.

One or several parameters can be defined in the by argument:

A object of class Subsection must be added to an object of class PresentationModel only if a Section object has been defined.

References

http://gpaux.github.io/Mediana/

See Also

See Also PresentationModel.

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
# Reporting
presentation.model = PresentationModel() +
  Section(by = "outcome.parameter") +
  Subsection(by = "sample.size") +
  CustomLabel(param = "sample.size",
              label= paste0("N = ",c(50, 55, 60, 65, 70))) +
  CustomLabel(param = "outcome.parameter",
              label=c("Standard 1", "Standard 2"))

# In this report, one section will be created for each outcome parameter assumption
# and within each section, a subsection will be created for each sample size.

gpaux/Mediana documentation built on May 31, 2021, 1:22 a.m.