eff.disc-class: Class 'eff.disc'

In julian-urbano/simIReff: Stochastic Simulation for Information Retrieval Evaluation: Effectiveness Scores

Description

This is the base S3 class for all discrete effectiveness distributions, which is itself a subclass of eff. Function effDisc_new is the constructor of the class.

Usage

effDisc_new(p, support, df, x = NULL)

Arguments

p	the values of the distribution function at the support points.
support	the support of the distribution.
df	the effective degrees of freedom of the distribution.
x	the sample of effectiveness scores used to fit the distribution. Defaults to NULL.

Details

A new distribution family is expected to build new objects through this constructor. Default implementations are readily available for methods deff, peff, qeff and reff.

Value

an object of class eff.disc, with the following components:

mean	the expected value.
var	the variance.
df	the degrees of freedom (effective number of parameters) for model selection.
support	the support of the distribution.
data	the sample data used to fit the distribution, or NULL if none.
model	a list with the family-specific data.

See Also

effDisc for a list of currently implemented distribution families, effDiscFit to fit distributions, and effDisc-helper for helper functions.

For continuous distributions, see eff.cont.

julian-urbano/simIReff documentation built on May 21, 2019, 9:37 a.m.