validate_stats_dm {dRiftDM}R Documentation

Validate a stats_dm Object

Description

validate_stats_dm is an internal (i.e., not exported) generic function to ensure that stats_dm objects, as well as their specific subclasses (cafs, quantiles, delta_funs, sum_dist, and fit_stats), meet the necessary structural and column requirements. Each method performs class-specific validation checks.

Usage

validate_stats_dm(stat_df)

## S3 method for class 'cafs'
validate_stats_dm(stat_df)

## S3 method for class 'quantiles'
validate_stats_dm(stat_df)

## S3 method for class 'delta_funs'
validate_stats_dm(stat_df)

## S3 method for class 'sum_dist'
validate_stats_dm(stat_df)

## S3 method for class 'fit_stats'
validate_stats_dm(stat_df)

## S3 method for class 'stats_dm'
validate_stats_dm(stat_df)

Arguments

stat_df

A data.frame of class stats_dm, cafs, quantiles, delta_funs, sum_dist, or fit_stats containing the calculated statistics to be validated.

Details

The validation process checks for required columns and structure based on the class of stat_df. Each class has specific requirements:

Value

Returns the unmodified stat_df for convenience.


[Package dRiftDM version 0.2.2 Index]