multiply: Multiply Water-Quality Data by a Number

View source: R/multiply.R

multiplyR Documentation

Multiply Water-Quality Data by a Number

Description

Multiplies water-quality data by a number while maintaining the integrity of the data.

Usage

multiply(x, factor, units, analyte, analyte.method = "ALGOR", pcode = "")

Arguments

x

an object of water-quality (class "qw"). Missing value are permitted and result in corresponding missing values in the output.

factor

a single numeric value

units

character reporting units of the resulting operation, if not supplied, retained from x.

analyte

character the name of the resulting analyte.

analyte.method

character the name of the analytical method for the result, by default "ALGOR."

pcode

the parameter code of the result, if not supplied, retained from x.

Details

Multiplication is not defined for objects of class "qw" because it can change some of the metadata, in particular the units, the analytical method, or the unique identifier (pcode).

Value

An object of class "qw" that is the result of the requested operation.


USGS-R/smwrQW documentation built on Oct. 11, 2022, 6:13 a.m.