distroptions

0th

Percentile

functions to change the global variables of the package `distr'

With distroptions and getdistrOption you may inspect and change the global variables used by package distr.

Keywords
distribution
Usage
distroptions(...)
getdistrOption(x)
Arguments

any options can be defined, using name = value or by passing a list of such tagged values.

x

a character string holding an option name.

Details

Invoking distroptions() with no arguments returns a list with the current values of the options. To access the value of a single option, one should use getdistrOption("WarningSim"), e.g., rather than distroptions("WarningSim") which is a list of length one.

Value

distroptions() returns a list of the global options of distr. distroptions("RtoDPQ.e") returns the global option RtoDPQ.e as a list of length 1. distroptions("RtoDPQ.e" = 3) sets the value of the global option RtoDPQ.e to 3. getdistrOption("RtoDPQ.e") the current value set for option RtoDPQ.e.

Currently available options

DefaultNrGridPoints

default number of grid points in integration, default value: 2^12

DistrResolution

minimal spacing between two mass points in a discrete distribution, default value: 1e-6

DistrCollapse

logical; in discrete distributions, shall support points with distance smaller than DistrResolution be collapsed; default value: TRUE

TruncQuantile

argument for q-slot at which to truncate; also, for discrete distributions, support is restricted to [q(TruncQuantile),q(1-TruncQuantile)], default value: 1e-5

DefaultNrFFTGridPointsExponent

by default, for e = DefaultNrFFTGridPointsExponent, FFT uses \(2^e\) gridpoints; default value: 12

RtoDPQ.e

by default, for reconstructing the d-,p-,q-slots out of simulations by slot r, RtoDPQ resp. RtoDPQ.d use \(10^e\) simulations, where e = RtoDPQ.e, default value: 5

WarningSim

if WarningSim==TRUE, print/show issue a warning as to the precision of d-,p-,q-slots when these are obtained by RtoDPQ resp. RtoDPQ.d, default value: TRUE

WarningArith

if WarningArith==TRUE, print/show issue a warning as to the interpretation of arithmetics operating on distributions, when the corresponding distribution to be plotted/shown is obtained by such an operation; keep in mind that arithmetics in fact operate on random variables distributed according to the given distributions and not on corresponding cdf's or densities; default value: TRUE

withSweave

is code run in Sweave (then no new graphic devices are opened), default value: FALSE

withgaps

controls whether in the return value of arithmetic operations the slot gaps of an the AbscontDistribution part is filled automatically based on empirical evaluations via setgaps ---default TRUE

simplifyD

controls whether in the return value of arithmetic operations there is a call to simplifyD or not ---default TRUE

use.generalized.inverse.by.default

logical; decides whether by default (i.e., if argument generalized of solve is not explicitely set), solve is to use generalized inverses if the original solve-method from package base fails; if the option is FALSE, in case of failure, and unless argument generalized is not explicitely set to TRUE, solve will throw an error as is the base-method behavior. The default value is TRUE.

DistrCollapse.Unique.Warn

controls whether there is a warning whenever collapsing occurs or when two points are collapsed by a call to unique() (default behaviour if DistrCollapse is FALSE); ---default FALSE

warn.makeDNew

controls whether a warning is issued once in internal utility .makeDNew standard integration with integrate throws an error---default TRUE

See Also

options, getOption

Aliases
  • distroptions
  • getdistrOption
  • DefaultNrGridPoints
  • DistrResolution
  • DistrCollapse
  • TruncQuantile
  • WarningSim
  • WarningArith
  • DefaultNrFFTGridPointsExponent
  • RtoDPQ.e
  • WarningArith
  • WarningSim
  • withSweave
  • warn.makeDNew
  • withgaps
  • use.generalized.inverse.by.default
  • DistributionAggregate.Unique.Warn
Examples
# NOT RUN {
distroptions("RtoDPQ.e") # returns the value of RtoDPQ.e, by default = 5
currentDistrOptions <- distroptions()
distroptions(RtoDPQ.e = 6)
distroptions("RtoDPQ.e") 
getdistrOption("RtoDPQ.e") 
distroptions(c("WarningSim","WarningArith"))   
getdistrOption("WarningSim")   
distroptions("WarningSim" = FALSE)   
         # switches off warnings as to (In)accuracy due to simulations
distroptions("WarningArith" = FALSE) 
         # switches off warnings as to arithmetics
distroptions(currentDistrOptions)
# }
Documentation reproduced from package distr, version 2.8.0, License: LGPL-3

Community examples

Looks like there are no examples yet.