censSumStats: Summary Statistics

View source: R/censSumStats.R

censSumStatsR Documentation

Summary Statistics

Description

Computes selected summary statistics for censored data.

Usage

censSumStats(..., group = NULL, Nums = TRUE, Stats = TRUE,
  Probs = (0:4)/4, na.rm = TRUE, method = "log MLE")

Arguments

...

any number of vectors or a data frame of the data to be summarized. If ... is a data frame, then only numeric data, including "lcens," "mcens," and "qw" data types, will be summarized.

group

the data to group the data in ....

Nums

logical, include the number of observations and numbers of censored values in the output data.frame.

Stats

logical, include the mean and standard deviation in the output data.frame.

Probs

the argument to quantile specifying the desired probabilities in the output data.frame

na.rm

logical, remove missing values before processing?

method

the method to use for computing the statistics. Must be one of "log MLE," "MLE," "log ROS," "ROS," or "flipped K-M." The method "flipped K-M" is only applicaple to un- or left-censored data.

Value

A data.frame with the selected statistcs for each variable in ... grouped by each unique value in group.


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