report.osmose: Report method for 'osmose' objects

In roliveros-ramos/osmose: Object Oriented Simulator of Marine Ecosystems

Report method for osmose objects

Description

Build and export a report of osmose objects using R markdown.

Usage

## S3 method for class 'osmose'
report(
  x,
  format = "pdf_document",
  output = NULL,
  tangle = FALSE,
  open = TRUE,
  ...
)

Arguments

x	Object of osmose class.
format	The R Markdown output format to convert to (check render).
output	The output directory for the rendered the output file.
tangle	Boolean; whether to tangle the R code from the input file (check render).
open	Do you want to open the output file at the end? (only useful for MS Windows environment).
...	Extra arguments pased to render.

roliveros-ramos/osmose documentation built on Feb. 19, 2023, 8:19 a.m.