prereg_spec_to_html {preregr}

Convert a (pre)registration specification to html

Description

Use this function to export your (pre)registration specification to an HTML file. To instead embed it in an R Markdown file, use prereg_knit_item_content().

Usage

prereg_spec_to_html(
  x,
  file = NULL,
  section = NULL,
  headingLevel = 1,
  silent = preregr::opts$get("silent")
)

Arguments

x

The (pre)registration object (as produced by a call to prereg_initialize()).

file

Optionally, a file to save the html to.

section

Optionally, one or multiple sections to include (if NULL, all sections are included).

headingLevel

The level of the top-most headings.

silent

Whether to be silent or chatty.

Value

The produced HTML, which will print in the viewer in RStudio.

Examples

### Load an example (pre)registration specification
data("examplePrereg_1", package = "preregr");

### Convert it to HTML and show the result
preregr::prereg_spec_to_html(
  examplePrereg_1
);