ypr (version 0.5.2)

ypr_report: Report

Description

Creates an Rmd file that can be used to generate a report.

Usage

ypr_report(
  population,
  Ly = 0,
  harvest = TRUE,
  biomass = FALSE,
  title = "Population Report",
  description = "",
  date = Sys.Date(),
  file = "report",
  view = FALSE,
  ask = TRUE
)

Value

An invisible character vector of the contents of the file.

Arguments

population

An object of class ypr_population().

Ly

The minimum length (trophy) fish to consider when calculating the yield (cm).

harvest

A flag specifying whether to calculate the yield for harvested fish or captures.

biomass

A flag specifying whether to calculate the yield in terms of the biomass versus number of individuals.

title

A string of the report title.

description

A string describing the population.

date

A date of the report date.

file

A string of the path to the file (without the extension).

view

A flag specifying whether to view the report (after rendering it to html).

ask

A flag specifying whether to ask before overwriting or creating a file.

Examples

ypr_report(ypr_population(), file = tempfile(), ask = FALSE)