F.release.summary: F.release.summary

F.release.summaryR Documentation

F.release.summary

Description

Summarize efficiency trials, or releases, for a site, run, and taxon, between specified dates.

Usage

F.release.summary(site, taxon, run, min.date, max.date, output.file)

Arguments

site

The identification number of the site for which estimates are required.

taxon

The species identifier indicating the type of fish of interest. This is always 161980; i.e., Chinook Salmon.

run

The biologist-assigned seasonal run.

min.date

The start date for data to include. This is a text string in the format %Y-%m-%d, or YYYY-MM-DD.

max.date

The end date for data to include. Same format as min.date.

output.file

The name of the file prefix under which output is to be saved. Set to NA to plot to the Plot window.

Details

Function F.release.summary calls helper functions F.get.release.data and F.summarize.releases to fetch, and then process, recorded releases. The results returned from F.summarize.releases are then cleaned up for output via a csv.

Value

A csv file summarizing efficiency trials for the specified criteria. A data frame containing the same information is also returned, but invisibly.

See Also

F.get.release.data, F.summarize.releases

Examples

## Not run: 
#   ---- Summarize releases for all efficiency trials involving Chinook
#   ---- salmon on the American River between Jan 16, 2013 and June 8, 2013.
site <- 57000
taxon <- 161980
min.date <- "2013-01-16"
max.date <- "2013-06-08"
output.file <- "American River"

df <- F.release.summary(site,taxon,min.date,max.date,output.file)

## End(Not run)

tmcd82070/CAMP_RST documentation built on April 6, 2022, 12:07 a.m.