CRHM_summary: Summarizes a 'CRHMr' data frame

View source: R/CRHM_summary.R

CRHM_summaryR Documentation

Summarizes a CRHMr data frame

Description

Summarizes the values in a CRHMr data frame. This is an internal CRHMr function and should never need to be called directly.

Usage

CRHM_summary(CRHMdataframe)

Arguments

CRHMdataframe

Required. Name of the CRHMr data frame to be summarized.

Value

If successful, returns a data frame containing the number of rows, complete rows, starting and ending datetimes, and the variables in the specified data frame. If unsuccessful, returns the value FALSE.

Author(s)

Kevin Shook

Examples

## Not run: 
summary <- CRHMsummary(BadLake7376)
## End(Not run)


CentreForHydrology/CRHMr documentation built on April 6, 2024, 5:27 p.m.