AIcheck: Error Check the Adult Index Data

View source: R/AIcheck.R

AIcheckR Documentation

Error Check the Adult Index Data

Description

Check the adult sea lamprey trapping data (collected for estimation of the Adult Index) for errors.

Usage

AIcheck(streamDat, csvDir, outFile = NULL, otherTabs = NULL)

Arguments

streamDat

A data frame of old and new stream mark-recapture estimates used to estimate the lake-wide Adult Indices, typically the output from AIprep. The data frame must include: year, lake, lake-stream ID lscode (see details), population estimate PEmr, coefficient of variation CVmr (100% * sqrt(variance(PEmr)) / PEmr), index, a logical identifying the index streams; maintain a logical identifying the streams that will continue to have ongoing trapping even if not part of the Adult Index; indexContrib a numeric, the stream population estimate that will be used in the Adult Index (NA for new); indexContribCV a numeric, the stream CV that will be used to generate 95% confidence intervals for the Adult Index (NA for new); and complete a logical identifying streams and years for which the Adult Index has already been estimated (FALSE for new).

csvDir

A character scalar identifying the path where the rtf file will be stored, e.g., csvDir = "C:\temp\mydir".

outFile

Name of the output rtf file, default NULL, in which case the file will be named "YYYY Adult Index - error checking.doc" where YYYY is the latest year represented in streamDat.

otherTabs

A list of other tables to be printed in error check report, default NULL. The list names will be used as captions.

Details

Lake-stream IDs are combination of lake ID and stream ID e.g., 1.064 = lake ID + (stream ID)/1000.

Value

An error checking document as an rtf file (with the file type *.doc, so that MS Word will open it automatically).


JVAdams/GLFC documentation built on Jan. 5, 2023, 12:59 a.m.