AdhereR (version 0.4)

print.CMA0: Print CMA0 (and derived) objects.

Description

Prints and summarizes a basic CMA0, or derived, object.

Usage

# S3 method for CMA0
print(x, ..., inline = FALSE, format = c("text",
  "latex", "markdown"), print.params = TRUE, print.data = TRUE,
  exclude.params = c("event.info"), skip.header = FALSE,
  cma.type = class(cma)[1])
# S3 method for CMA1
print(...)
# S3 method for CMA2
print(...)
# S3 method for CMA3
print(...)
# S3 method for CMA4
print(...)
# S3 method for CMA5
print(...)
# S3 method for CMA6
print(...)
# S3 method for CMA7
print(...)
# S3 method for CMA8
print(...)
# S3 method for CMA9
print(...)
# S3 method for CMA_per_episode
print(x, ..., inline = FALSE,
  format = c("text", "latex", "markdown"), print.params = TRUE,
  print.data = TRUE, exclude.params = c("event.info"),
  skip.header = FALSE, cma.type = class(cma)[1])
# S3 method for CMA_sliding_window
print(...)

Arguments

x

A CMA0 or derived object, representing the CMA to print.

...

other possible parameters

inline

Logical, should print inside a line of text or as a separate, extended object?

format

A string, the type of output: plain text ("text"; default), LaTeX ("latex") or R Markdown ("markdown").

print.params

Logical, should print the parameters?

print.data

Logical, should print a summary of the data?

exclude.params

A vector of strings, the names of the object fields to exclude from printing (usually, internal information irrelevant to the end-user).

skip.header

Logical, should the header be printed?

cma.type

A string, used to override the reported object's class.

Details

Can produce output for the console (text), R Markdown or LaTeX, showing various types of information.

Examples

# NOT RUN {
cma0 <- CMA0(data=med.events,
             ID.colname="PATIENT_ID",
             event.date.colname="DATE",
             event.duration.colname="DURATION",
             event.daily.dose.colname="PERDAY",
             medication.class.colname="CATEGORY",
             followup.window.start=0,
             followup.window.start.unit="days",
             followup.window.duration=2*365,
             followup.window.duration.unit="days",
             observation.window.start=30,
             observation.window.start.unit="days",
             observation.window.duration=365,
             observation.window.duration.unit="days",
             date.format="%m/%d/%Y",
             summary="Base CMA");
cma0;
print(cma0, format="markdown");
cma1 <- CMA1(data=med.events,
             ID.colname="PATIENT_ID",
             event.date.colname="DATE",
             event.duration.colname="DURATION",
             followup.window.start=30,
             observation.window.start=30,
             observation.window.duration=365,
             date.format="%m/%d/%Y"
            );
cma1;
# }