ypr_report: Report

In poissonconsulting/ypr: Yield Per Recruit

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
)

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.

Value

An invisible character vector of the contents of the file.

See Also

Other tabulate: ypr_detabulate_parameters(), ypr_tabulate_biomass(), ypr_tabulate_fish(), ypr_tabulate_parameters(), ypr_tabulate_schedule(), ypr_tabulate_sr(), ypr_tabulate_yields(), ypr_tabulate_yield()

Examples

## Not run: 
ypr_report(ypr_population(), file = tempfile(), ask = FALSE)

## End(Not run)

poissonconsulting/ypr documentation built on April 4, 2023, 8:35 p.m.