run_report: Generate an Rmarkdown report of salmon escapement

In mccrea-cobb/akulara: Analyze and Report on Salmon Abundances using Photo and Video Count Data

Generate an Rmarkdown report of salmon escapement

Description

Generate an Rmarkdown report of salmon escapement

Usage

run_report(
  outformat = bookdown::pdf_document2(),
  outfile = "report",
  outdir = getwd(),
  parameters = "ask",
  ...
)

Arguments

outformat	the file format of the report. Default is bookdown::pdf_document2().
outfile	a name of the returned file
outdir	a directory path to the folder to save the PDF
parameters	a list of custom parameters or all to launch a shiny app to select custom parameters
...	pass additional arguments to rmarkdown::render()

Value

an RMarkdown-generated report

Examples

## Not run: 
run_report()

## End(Not run)

mccrea-cobb/akulara documentation built on Nov. 14, 2024, 4:17 a.m.