Create Reportr object

Source: R/classes.R

create_wsteps creates the Reportr object and the necessary structure for the package's functions.

create_wsteps(
  steps,
  project.name = "My project",
  author = Sys.info()[["user"]],
  affiliation = "Lab",
  email = paste0(Sys.info()[["user"]], "@email.com"),
  address = "file://",
  path = "",
  markdown = list("")
)

Arguments

steps

List of paths (and other arguments embedded in each element of the list).
project.name

The name of your workflow/project, Default = 'My project'.
author

Author, Default = Sys.info user.
affiliation

Author, Default = 'Lab'.
email

Author's email.
address

Server address, Default: 'file://'.
path

Path equivalent of the address, Default: ''.
markdown

Markdown specs.

Value

A Reportr object.

Examples

if (FALSE) {
 if(interactive()) create_wsteps(list())
}