writeMarkdown: Write markdown based on modeled data

In jonkeane/mocapGrip: Illusion-Grip Motion Capture Package

Description

Write markdown based on modeled data

Usage

writeMarkdown(modeledData, markdownPath = "./report.Rmd",
  analysisSkel = readLines(system.file("markdown", "analysisSkeleton.Rmd",
  package = "mocapGrip", mustWork = TRUE)),
  header = readLines(system.file("markdown", "header.Rmd", package =
  "mocapGrip", mustWork = TRUE)), modelMd = modelMetadata)

Arguments

modeledData	a list of modeled data of the format from modelAllData
markdownPath	a string of the path to store the report markdown file. By default is is "./report.Rmd"
analysisSkel	an R Markdown (.Rmd) file that has the skeleton for the analysis. This skeleton is the output for a single analysis. It will be repeated if multiple analysis types are in modeledData. It includes special variables which will be replaced with information from modelMetadata. These special variables look like <>$intro<>, which would be replaced with the text marked intro in modelMetadata for the specific analysis in modeledData.
header	an R Markdown file that has header information so that the report can be generated.
modelMd	a modelMetadata object, by default it uses the modelMetadata that comes with the package.

Value

None

jonkeane/mocapGrip documentation built on May 19, 2019, 7:30 p.m.