create_wsteps: Create Reportr object

In cramirezs/wreportr: Summarise Your Folders

Description

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

Usage

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

## Not run: 
 if(interactive()) create_wsteps(list())

## End(Not run)

cramirezs/wreportr documentation built on Dec. 19, 2021, 6:09 p.m.