use_file: Write a template file

In ddsjoberg/bstfun: Functions for the MSK Biostatistics Department

Write a template file

Description

Rather than using create_bst_project() to start a new project folder, you may use use_bst_file() to write a single file from any project template. The functions use_bst_gitignore() and use_bst_readme() are shortcuts for use_bst_file("gitignore") and use_bst_file("readme").

Usage

use_bst_file(name = NULL, filename = NULL, open = interactive())

use_bst_gitignore(filename = NULL)

use_bst_readme(filename = NULL)

use_bst_setup(filename = NULL)

use_bst_analysis(filename = NULL)

use_bst_report(filename = NULL)

Arguments

name	Name of file to write. Not sure of the files available to you? Run the function without specifying a name, and all files available within the template will print.
filename	Optional argument to specify the name of the file to be written. Paths/filename is relative to project base
open	If TRUE, opens the new file.

See Also

create_bst_project()

Examples

if (FALSE) {
# create gitignore file
use_bst_file("gitignore")
use_bst_gitignore()

# create README.md file
use_bst_file("readme")
use_bst_readme()
}

ddsjoberg/bstfun documentation built on July 4, 2023, 10:59 a.m.