write_manuscript: Write manuscript

In ready4-dev/ready4show: Author Health Economic Analysis Programs and Reporting Templates

Write manuscript

Description

write_manuscript() is a Write function that writes a file to a specified local directory. Specifically, this function implements an algorithm to write manuscript. The function returns Results (a list).

Usage

write_manuscript(
  abstract_args_ls = NULL,
  consent_1L_chr = "",
  consent_indcs_int = 1L,
  input_params_ls = NULL,
  figures_in_body_lgl = NULL,
  ms_mkdn_fl_nm_1L_chr = "TTU_Study_Manuscript",
  ms_mkdn_parent_1L_chr = "ready4-dev",
  ms_mkdn_repo_1L_chr = "ttu_lng_ss",
  options_chr = c("Y", "N"),
  output_type_1L_chr = NULL,
  results_ls = NULL,
  tables_in_body_lgl = NULL,
  title_1L_chr = "Scientific manuscript",
  version_1L_chr = "0.5",
  write_to_dv_1L_lgl = F
)

Arguments

abstract_args_ls	Abstract arguments (a list), Default: NULL
consent_1L_chr	Consent (a character vector of length one), Default: ”
consent_indcs_int	Consent indices (an integer vector), Default: 1
input_params_ls	Input parameters (a list), Default: NULL
figures_in_body_lgl	Figures in body (a logical vector), Default: NULL
ms_mkdn_fl_nm_1L_chr	Manuscript markdown file name (a character vector of length one), Default: 'TTU_Study_Manuscript'
ms_mkdn_parent_1L_chr	Manuscript markdown parent (a character vector of length one), Default: 'ready4-dev'
ms_mkdn_repo_1L_chr	Manuscript markdown repository (a character vector of length one), Default: 'ttu_lng_ss'
options_chr	Options (a character vector), Default: c("Y", "N")
output_type_1L_chr	Output type (a character vector of length one), Default: NULL
results_ls	Results (a list), Default: NULL
tables_in_body_lgl	Tables in body (a logical vector), Default: NULL
title_1L_chr	Title (a character vector of length one), Default: 'Scientific manuscript'
version_1L_chr	Version (a character vector of length one), Default: '0.5'
write_to_dv_1L_lgl	Write to dataverse (a logical vector of length one), Default: F

Value

Results (a list)

See Also

rmarkdown::render()

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