Project: Project object

Description Usage Arguments Details References See Also Examples

View source: R/Project.R

Description

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

Usage

1
2
3
4
5
Project(
  username = "[Unknown User]",
  title = "[Unknown title]",
  description = "[No description]"
)

Arguments

username

defines the username to be printed in the report.

title

defines the title of the project to be printed in the report.

description

defines the description of the project to be printed in the report.

Details

Objects of class Project are used in objects of class PresentationModel to add more details on the project, such as the author, a title and a destiption of the project. This information will be added in the report generated using the GenerateReport function. A single object of class Project can be added to an object of class PresentationModel.

References

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

See Also

See Also PresentationModel and GenerateReport.

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
# Reporting
presentation.model = PresentationModel() +
  Project(username = "[Mediana's User]",
          title = "Case study 1",
          description = "Clinical trial in patients with pulmonary arterial hypertension") +
  Section(by = "outcome.parameter") +
  Table(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"))

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