F.plot.passage: F.plot.passage

In tmcd82070/CAMP_RST: CAMP RST R Routines

F.plot.passage

Description

Plot a bar graph of the passage estimates in the temporal units specified by the user in the original passage function call.

Usage

F.plot.passage(df, out.file = "passage.png")

Arguments

df	A data frame containing passage estimates calculated via function F.est.passage per one of day, week, month, or year.
out.file	The name of the file prefix under which output is to be saved. Set to NA to plot to the Plot window.

Details

It is assumed that data frame df contains at the least variables <temporal time frame>, passage, date, and pct.imputed.catch. Variable <temporal time frame> is either one of "year," "month," "week," or "day." Weeks are reported in a modified Julian fashion as recorded in the "Dates" table in any associated CAMP Access database. Passage estimates for each reported time period are rounded to the nearest whole fish. Variable date is a POSIX date, with data formatted as %Y-%m-%d, i.e., the ISO 8601 date format, with a 4-digit year. Variable pct.imputed.catch contains the estimated imputed proportion, and so takes on values between zero and one, inclusive.

Other variables included as part of dataframe df are not utilized per se in the function, but do pass through.

Value

Output includes a png graphical display of total estimated passage by specified temporal unit. Temporal units, or bars in the graph, display both the number of observed fish and imputed fish. The total number of estimated fish over the entire temporal range is also reported.

Author(s)

WEST Inc.

See Also

F.est.passage

Examples

## Not run: 
#   ---- Plot passage estimates per temporal time unit to
#   ---- the plot window.
F.plot.passage( df, out.file=NA )

## End(Not run)

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