rmd_templates: Convert a (pre)registration form to an R Markdown template

In preregr: Specify (Pre)Registrations and Export Them Human- And Machine-Readably

Convert a (pre)registration form to an R Markdown template

Description

This function creates an R Markdown template from a preregr (pre)registrations form specification. Pass it the URL to a Google Sheet holding the (pre)registration form specification (in preregr format), see the "Creating a form from a spreadsheet" vignette), the path to a file with a spreadsheet holding such a specification, or a loaded or imported preregr (pre)registration form.

Usage

form_to_rmd_template(
  x,
  file = NULL,
  title = NULL,
  author = NULL,
  date = "`r format(Sys.time(), '%Y-%m-%d at %H:%M:%S %Z (UTC%z)')`",
  output = "html_document",
  yaml = list(title = title, author = author, date = date, output = output),
  includeYAML = TRUE,
  chunkOpts = "echo=FALSE, results='hide'",
  justify = FALSE,
  headingLevel = 2,
  showSpecification = FALSE,
  preventOverwriting = preregr::opts$get("preventOverwriting"),
  silent = preregr::opts$get("silent")
)

## S3 method for class 'preregr_rmd_template'
print(x, ...)

Arguments

x	The (pre)registration form (as produced by a call to form_create() or import_from_html()) or initialized preregr object (as produced by a call to prereg_initialize() or import_from_html()); or, for the printing method, the R Markdown template produced by a call to form_to_rmd_template().
file	Optionally, a file to save the html to.
title	The title to specify in the template's YAML front matter.
author	The author to specify in the template's YAML front matter.
date	The date to specify in the template's YAML front matter.
output	The output format to specify in the template's YAML front matter.
yaml	It is also possible to specify the YAML front matter directly using this argument. If used, it overrides anything specified in title, author, date and output.
includeYAML	Whether to include the YAML front matter or omit it.
chunkOpts	The chunk options to set for the chunks in the template.
justify	Whether to use prereg_specify() as function for specifying the (pre)registration content (if FALSE), or prereg_justify() (if TRUE).
headingLevel	The level of the top-most heading to use (the title of the (pre)registration form).
showSpecification	Whether to show the specification in the Rmd output. When FALSE, the preregr option silent is set to TRUE at the start of the Rmd template; otherwise, it is set to FALSE.
preventOverwriting	Set to FALSE to override overwrite prevention.
silent	Whether to be silent or chatty.
...	Additional argument are ignored.

Value

x, invisibly

Examples

preregr::form_create(
  title = "Example form",
  version = "0.1.0"
) |>
  preregr::form_to_rmd_template();

preregr documentation built on May 31, 2023, 7:10 p.m.