build_report: Generate a knitr report for a specified analysis

Description Usage Arguments Details Value

Description

Generate a knitr report for a specified analysis

Usage

1
build_report(path, data, title = "Example", seed = 47209)

Arguments

path

Character vector specifying the path of a duplicated analysis template, should the user choose to use this instead

data

A list object containing all relevant data elements. Specific attributes are defined in the details.

title

A character string setting the report title. Default "Example".

seed

A random seed set at the beginning of the report. Default 47209

Details

This is a generic function that passes a data object to an analysis template of the user's choosing. The template checks the data object to ensure compatibility.

Value

An object, as specified in the description of the chosen analysis


prpatil/tdsm documentation built on May 26, 2019, 10:32 a.m.