struct_report: Constructor for struct_report objects

In computational-metabolomics/structReport: struct Report Builder

Description

Creates a new struct_report object and populates the slots.

Usage

struct_report(
  title,
  author = "Anon",
  format = "html_document",
  toc = TRUE,
  toc_depth = 2,
  sections = list(),
  ...
)

## S4 method for signature 'struct_report,ANY,ANY,ANY'
x[i]

## S4 replacement method for signature 'struct_report,ANY,ANY,ANY'
x[i] <- value

## S4 method for signature 'struct_report'
length(x)

## S4 method for signature 'report_section,struct_report'
e1 + e2

## S4 method for signature 'struct_report,report_section'
e1 + e2

## S4 method for signature 'report_section,report_section'
e1 + e2

## S4 method for signature 'struct_report,struct_report'
e1 + e2

## S4 method for signature 'struct_report,character'
build_report(R, outfile)

Arguments

title	the title of the report.
author	the author of the report
format	the format of the report. One of 'html_document','pdf_document','word_document'. Default = 'html_document'
sections	a list of report_sections

Value

a struct_class object

model for the report section at the given index

struct_report with the model for the section at index i replaced

the number of sections in a struct_report

a struct_report with the additional section appended to the front of the sequence

a struct_report with the additional section appended to the end of the sequence

a struct report containing the combined sections

a struct report containing a section for each of the input reports

Examples

MS = report_section() + report_section()
MS[2]

MS = report_section() + report_section()
MS[2] = model()

MS = report_section() + report_section()
length(MS) # 2

MS = model_report() + model_report()
M = model_report()
MS = M + MS

MS = model_report() + model_report()
M = model_report()
MS = MS + M

MS = report_section() + report_section()

MS = struct_report() + struct_report()

computational-metabolomics/structReport documentation built on Nov. 12, 2020, 2:33 a.m.