jfa-methods: Methods for jfa objects

In jfa: Statistical Methods for Auditing

Methods for jfa objects

Description

Methods defined for objects returned from the auditPrior, planning, selection, and evaluation functions.

Usage

## S3 method for class 'jfaPrior'
print(x, ...)

## S3 method for class 'summary.jfaPrior'
print(x, digits = getOption("digits"), ...)

## S3 method for class 'jfaPrior'
summary(object, digits = getOption("digits"), ...)

## S3 method for class 'jfaPrior'
predict(object, n, cumulative = FALSE, ...)

## S3 method for class 'jfaPredict'
print(x, ...)

## S3 method for class 'jfaPrior'
plot(x, ...)

## S3 method for class 'jfaPredict'
plot(x, ...)

## S3 method for class 'jfaPosterior'
print(x, ...)

## S3 method for class 'summary.jfaPosterior'
print(x, digits = getOption("digits"), ...)

## S3 method for class 'jfaPosterior'
summary(object, digits = getOption("digits"), ...)

## S3 method for class 'jfaPosterior'
predict(object, n, cumulative = FALSE, ...)

## S3 method for class 'jfaPosterior'
plot(x, ...)

## S3 method for class 'jfaPlanning'
print(x, ...)

## S3 method for class 'summary.jfaPlanning'
print(x, digits = getOption("digits"), ...)

## S3 method for class 'jfaPlanning'
summary(object, digits = getOption("digits"), ...)

## S3 method for class 'jfaPlanning'
plot(x, ...)

## S3 method for class 'jfaSelection'
print(x, ...)

## S3 method for class 'summary.jfaSelection'
print(x, digits = getOption("digits"), ...)

## S3 method for class 'jfaSelection'
summary(object, digits = getOption("digits"), ...)

## S3 method for class 'jfaEvaluation'
print(x, digits = getOption("digits"), ...)

## S3 method for class 'summary.jfaEvaluation'
print(x, digits = getOption("digits"), ...)

## S3 method for class 'jfaEvaluation'
summary(object, digits = getOption("digits"), ...)

## S3 method for class 'jfaEvaluation'
plot(x, type = c("estimates", "posterior"), ...)

## S3 method for class 'jfaDistr'
print(x, digits = getOption("digits"), ...)

## S3 method for class 'summary.jfaDistr'
print(x, digits = getOption("digits"), ...)

## S3 method for class 'jfaDistr'
summary(object, digits = getOption("digits"), ...)

## S3 method for class 'jfaDistr'
plot(x, type = c("estimates", "robustness", "sequential"), ...)

## S3 method for class 'jfaRv'
print(x, digits = getOption("digits"), ...)

## S3 method for class 'jfaRv'
plot(x, ...)

## S3 method for class 'jfaFairness'
print(x, digits = getOption("digits"), ...)

## S3 method for class 'summary.jfaFairness'
print(x, digits = getOption("digits"), ...)

## S3 method for class 'jfaFairness'
summary(object, digits = getOption("digits"), ...)

## S3 method for class 'jfaFairness'
plot(x, type = c("estimates", "posterior", "robustness", "sequential"), ...)

Arguments

...	further arguments, currently ignored.
digits	an integer specifying the number of digits to which output should be rounded. Used in summary.
object, x	an object of class jfaPrior, jfaPosterior, jfaPlanning, jfaSelection, jfaEvaluation, jfaDistr, jfaRv, or jfaFairness.
n	used in predict. Specifies the sample size for which predictions should be made.
cumulative	used in predict. Specifies whether cumulative probabilities should be shown.
type	used in plot. Specifies the type of plot to produce.

Value

The summary methods return a data.frame which contains the input and output.

The print methods simply print and return nothing.

jfa documentation built on Sept. 11, 2024, 7:59 p.m.