get_head_stats: Calculate Hydraulic Head Statistics

In mlms: Multilevel Monitoring System Data for Wells in the USGS INL Aquifer Monitoring Network

Calculate Hydraulic Head Statistics

Description

Calculate summary statistics for multi-level hydraulic head data, categorized by site and port, and summarized over time.

Usage

get_head_stats(vars = NULL, by_port = FALSE)

Arguments

vars

'character' vector. One or more variable names for which to compute summary statistics. Choices include: "total_head_va" is the hydraulic head in feet above the North American Vertical Datum of 1988, "temp_va" is the fluid temperature in degree Celsius, "baro_va" is the atmospheric pressure in pounds per square inch absolute (psi), and "press_va" is the absolute fluid pressure in psi. By default, all variables are included.

by_port

'logical' flag. Whether to compute statistics according to a sites monitoring port. Defaults to grouping by site only.

Value

A data frame with the following variables:

var_ds

Variable description.

var_nm

Variable name as specified in the vars argument.

site_nm

Local site name for a MLMS well.

port_nu

Identifier for the valved measurement port, included only if the by_port argument is set to true (not the default).

n

Sample size, which is the number of records in a given sample that contain finite values.

nna

Number of missing values that were stripped before the statistic was computed.

start_dt

Start date for the period of record.

end_dt

End date for the period of record.

duration

Duration of the record period, measured in years.

mean

Arithmetic mean of the variable values.

sd

Standard deviation of the variable values.

min

Minimum of the variable values.

qu_1st

First quartile of the variable values.

median

Median of the variable values.

qu_3rd

Third quartile of the variable values.

max

Maximum of the variable values.

Author(s)

J.C. Fisher, U.S. Geological Survey, Idaho Water Science Center

See Also

get_head_outliers function may be used to identify fluid pressure outliers.

Examples

d <- get_head_stats()
str(d)

d <- get_head_stats(vars = "press_va", by_port = TRUE)
str(d)

mlms documentation built on April 4, 2025, 4:43 a.m.