map_to_generic_hierarchical_html: html from resultlist with results in specified hierarchical...

Description Usage Arguments

View source: R/map_to_generic_hierarchical_template.R

Description

html from resultlist with results in specified hierarchical order based on analysisplan

Usage

1
2
3
4
map_to_generic_hierarchical_html(resultlist, render_result_with,
  by_analysisplan_columns = c("dependent.var"), by_prefix = c("",
  "subset:", "variable:"), level = 2, questionnaire = NULL,
  label_varnames = TRUE, dir = "./", filename)

Arguments

resultlist

structure like the output from from_analysisplan_map_to_output: A list with two items "analysisplan" and "results": The "analysisplan" as a data frame, where each row must match a result in a list of "results"

render_result_with

a function that takes a single result as input and returns an rmarkdown formated string

by_analysisplan_columns

vector of strings matching column names of the analysisplan. The first element becomes the main heading, the second element the sub-heading etc.

by_prefix

a prefix added at the beginnig of the headline; same length as 'by_analysisplan_columns'

level

the markdown header level to start with; defaults to 2 which leads to "## heading", i.e. the second header level.

questionnaire

optional; the questionnaire (koboquest::load_questionnaire())

label_varnames

wether variables names should be labeled in headings

dir

the directory in which to save the output file (absolute path or relative to current working directory)

filename

the name of the file. must end in '.html'

type

the type of report template to use. Currently one of "full", "visual" or "summary"


mabafaba/hypegrammaR documentation built on Oct. 2, 2019, 11:33 a.m.