Characteristic-class: S4 Class Definition for Characteristic object in NCRNWater
In NCRN/NCRNWater: Data analysis and visualization for NPS I&M water monitoring
Characteristic-class R Documentation
S4 Class Definition for Characteristic object in NCRNWater
Description
An S4 class that contains the data from water monitoring for a single water quality characteristic as a single site in a single park.
Slots
CharacteristicNameThe name of the water quality characteristic. Stored as a length 1 character vector.
DisplayNameA name for the characteristic suitable for display on graphs, tables etc. Stored as a length 1 character vector.
SubstrateThe substrate of the characteristic, stored as a length 1 character vector.
SampleFractionThe sample fraction of the characteristic. Stored as a length 1 character vector.
CategoryThe category for the characteristic. Stored as a length 1 character vector.
CategoryDisplayThe display name for the category, suitable for graphs, tables etc.
DetailsA description of the characteristic as needed. Stored as a length 1 character vector.
UnitsThe units of measurement of the characteristic. Stored as a length 1 character vector.
DataA data.frame containing the water quality data. Should have columns representing the date, measurement, any QAQC flags etc. for each measurement.
LowerPoint,UpperPointIndicates the assessment points. Values lower than the lower point are considered to have failed the assessment,
whereas values higher than the higher point are considered failures. Can either be a length 1 numerical vector, or a data.frame
giving the lower assessment value for each measurement. The vector method should be used for assessments that do not change, whereas the data.frame is for
assessment that change based on the time of the year or other factors.
LowerType,UpperTypeThe type of assessment indicated by the lower and upper points. A length 1 character vector.
LowerDescription,UpperDescriptionA description of the lower and upper assessments point. Stored as a length 1 character vector.
AssessmentDetailsAdditional description of the assessment point. Stored as a length 1 character vector.
NCRN/NCRNWater documentation built on May 15, 2023, 9:50 p.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
| Characteristic-class | R Documentation |
S4 Class Definition for Characteristic object in NCRNWater
Description
An S4 class that contains the data from water monitoring for a single water quality characteristic as a single site in a single park.
Slots
CharacteristicNameThe name of the water quality characteristic. Stored as a length 1 character vector.
DisplayNameA name for the characteristic suitable for display on graphs, tables etc. Stored as a length 1 character vector.
SubstrateThe substrate of the characteristic, stored as a length 1 character vector.
SampleFractionThe sample fraction of the characteristic. Stored as a length 1 character vector.
CategoryThe category for the characteristic. Stored as a length 1 character vector.
CategoryDisplayThe display name for the category, suitable for graphs, tables etc.
DetailsA description of the characteristic as needed. Stored as a length 1 character vector.
UnitsThe units of measurement of the characteristic. Stored as a length 1 character vector.
DataA
data.framecontaining the water quality data. Should have columns representing the date, measurement, any QAQC flags etc. for each measurement.LowerPoint,UpperPointIndicates the assessment points. Values lower than the lower point are considered to have failed the assessment, whereas values higher than the higher point are considered failures. Can either be a length 1 numerical vector, or a
data.framegiving the lower assessment value for each measurement. The vector method should be used for assessments that do not change, whereas thedata.frameis for assessment that change based on the time of the year or other factors.LowerType,UpperTypeThe type of assessment indicated by the lower and upper points. A length 1 character vector.
LowerDescription,UpperDescriptionA description of the lower and upper assessments point. Stored as a length 1 character vector.
AssessmentDetailsAdditional description of the assessment point. Stored as a length 1 character vector.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.