R: Functions used to describe the characteristics of estimated...

distribution {mlogit} | R Documentation

## Functions used to describe the characteristics of estimated random parameters

### Description

`rpar` objects contain all the relevant information about the distribution of random parameters. These functions enables to obtain easily descriptive statistics, density, probability and quantiles of the distribution.

### Usage

    med(x, ...)
    stdev(x, ...)
    rg(x, ...)
    qrpar(x, ...)
    prpar(x, ...)
    drpar(x, ...)
    ## S3 method for class 'rpar'
    mean(x, norm = NULL, ...)
    ## S3 method for class 'rpar'
    med(x, norm = NULL, ...)
    ## S3 method for class 'rpar'
    stdev(x, norm = NULL, ...)
    ## S3 method for class 'rpar'
    rg(x, norm = NULL, ...)
    ## S3 method for class 'mlogit'
    mean(x, par = NULL, norm = NULL, ...)
    ## S3 method for class 'mlogit'
    med(x, par = NULL, norm = NULL, ...)
    ## S3 method for class 'mlogit'
    stdev(x, par = NULL, norm = NULL, ...)
    ## S3 method for class 'mlogit'
    rg(x, par = NULL, norm = NULL, ...)
    ## S3 method for class 'rpar'
    stdev(x, norm = NULL, ...)
    ## S3 method for class 'rpar'
    qrpar(x, norm = NULL, ...)
    ## S3 method for class 'rpar'
    prpar(x, norm = NULL, ...)
    ## S3 method for class 'rpar'
    drpar(x, norm = NULL, ...)
    ## S3 method for class 'mlogit'
    qrpar(x, par = 1, y = NULL, norm = NULL, ...)
    ## S3 method for class 'mlogit'
    prpar(x, par = 1, y = NULL, norm = NULL, ...)
    ## S3 method for class 'mlogit'
    drpar(x, par = 1, y = NULL, norm = NULL, ...)

### Arguments

`x` | a `mlogit` or a `rpar` object,
`norm` | the variable used for normalization if any : for the `mlogit` method, this should be the name of the parameter, for the `rpar` method the absolute value of the parameter,
`par` | the required parameter(s) for the `mlogit` methods (either the name or the position of the parameter(s). If `NULL`, all the random parameters are used.
`y` | values for which the function has to be evaluated,
`...` | further arguments.

### Details

`mean`, `med`, `stdev` and `rg` compute respectively the mean, the median, the standard deviation and the range of the random parameter. `qrpar`, `prpar`, `drpar` return functions that compute the quantiles, the probability and the density of the random parameters (note that `sd` and `range` are not generic function in `R` and that `median` is, but without `...`).

### Value

a numeric vector for `qrpar`, `drpar` and `prpar`, a numeric vector for `mean`, `stdev` and `med` and a numeric matrix for `rg`.

### Author(s)

Yves Croissant

### See Also

`mlogit` for the estimation of random parameters logit models and `rpar` for the description of `rpar` objects.

[Package mlogit version 0.3-0 Index]