write_csp_output: Write complete study program output

write_csp_outputR Documentation

Write complete study program output

Description

write_csp_output() is a Write function that writes a file to a specified local directory. Specifically, this function implements an algorithm to write complete study program output. The function is called for its side effects and does not return a value.

Usage

write_csp_output(
  path_to_csp_1L_chr,
  consent_1L_chr = "",
  consent_indcs_int = 1L,
  description_1L_chr = "Methods Report 1: Complete Study Program",
  dv_ds_doi_1L_chr = NULL,
  options_chr = c("Y", "N"),
  execute_1L_lgl = T
)

Arguments

path_to_csp_1L_chr

Path to complete study program (a character vector of length one)

consent_1L_chr

Consent (a character vector of length one), Default: ”

consent_indcs_int

Consent indices (an integer vector), Default: 1

description_1L_chr

Description (a character vector of length one), Default: 'Methods Report 1: Complete Study Program'

dv_ds_doi_1L_chr

Dataverse dataset digital object identifier (a character vector of length one), Default: NULL

options_chr

Options (a character vector), Default: c("Y", "N")

execute_1L_lgl

Execute (a logical vector of length one), Default: T

Value

No return value, called for side effects.

See Also

rmarkdown::render()


ready4-dev/ready4show documentation built on June 16, 2024, 8:08 a.m.