write_header_yaml: Write header yaml

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

Write header yaml

Description

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

Usage

write_header_yaml(
  path_to_header_dir_1L_chr,
  authors_tb,
  institutes_tb,
  consent_1L_chr = "",
  consent_indcs_int = 1L,
  fl_nm_1L_chr = "header.yaml",
  inc_quals_1L_lgl = F,
  keywords_chr = c("Example keyword one", "Example keyword two"),
  options_chr = c("Y", "N"),
  path_to_tmpl_header_1L_chr = NULL,
  title_1L_chr = "Example title"
)

Arguments

path_to_header_dir_1L_chr	Path to header directory (a character vector of length one)
authors_tb	Authors (a tibble)
institutes_tb	Institutes (a tibble)
consent_1L_chr	Consent (a character vector of length one), Default: ”
consent_indcs_int	Consent indices (an integer vector), Default: 1
fl_nm_1L_chr	File name (a character vector of length one), Default: 'header.yaml'
inc_quals_1L_lgl	Include qualifications (a logical vector of length one), Default: F
keywords_chr	Keywords (a character vector), Default: c("Example keyword one", "Example keyword two")
options_chr	Options (a character vector), Default: c("Y", "N")
path_to_tmpl_header_1L_chr	Path to template header (a character vector of length one), Default: NULL
title_1L_chr	Title (a character vector of length one), Default: 'Example title'

Value

No return value, called for side effects.

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