utils_knit_opts: Set up knitr options

In iantaylor-NOAA/Lingcod_2021: Estimate the Status of Lingcod off the US West Coast in 2021

Set up knitr options

Description

Set up the knitr options for the rendering of various file types within the package. Using verbose = TRUE can help you you are trying to debug your script, but the default is FALSE for production.

Usage

utils_knit_opts(type = c("data-raw"), verbose = FALSE)

Arguments

type

A character entry specifying which type of file you are rendering. data-raw: if you are at the top level of your directory, e.g., lingcod_2021, and you will be rendering a file in the data-raw folder, then type = "data-raw" allows you to set your working directory back to the top level so that all of the file links will work, otherwise knitr thinks that the script is written such that all paths are relative to where the script lives.

verbose

A logical value specifying if output should be printed to the console or not. The default is FALSE, which will suppress messages.

Value

Nothing is returned from this function.

Author(s)

Kelli Faye Johnson

iantaylor-NOAA/Lingcod_2021 documentation built on Oct. 30, 2024, 6:42 p.m.