Skip to contents

Copy, and optionally render, a FLOSS guide

Source: R/guide.R
floss_guide.Rd

The guides are installed with the package (folder guide), whether or not the vignettes were built. floss_guide() writes a guide to dir as a stand-alone R Markdown file that you can edit and knit, plus an R script with its code, and with render = TRUE renders it to HTML.

Usage

floss_guide(
  guide = c("user-guide", "teaching", "cpue-aggregation", "methods", "how-it-works",
    "reef-om", "all"),
  dir = ".",
  render = FALSE,
  script = TRUE,
  open = interactive(),
  overwrite = FALSE
)

Arguments

guide

"user-guide", "teaching", "cpue-aggregation", "methods" (appendix with the equations), "how-it-works", "reef-om", or "all".

dir

folder to write to (created).

render

also render to HTML (needs 'rmarkdown' and pandoc; runs all the code, which takes a few minutes for the user guide and the teaching scenarios).

script

also write the R script: the code with the guide text as #' comments (knitr::purl() with documentation = 2). Fully commented scripts of the user guide and the teaching scenarios are also installed: system.file("guide", "FLOSS_user_guide.R", package = "FLOSS").

open

open the HTML after rendering.

overwrite

replace existing files.

Value

the paths of the files written, invisibly.

Examples

if (FALSE) {
floss_guide("user-guide")                 # floss-02-user-guide.Rmd and .R
floss_guide("all", dir = "guides", render = TRUE)
}