# Student: Non-central Student distribution In boodist: Some Distributions from the 'Boost' Library and More

 Student R Documentation

## Non-central Student distribution

### Description

A R6 class to represent a non-central Student distribution.

### Active bindings

`nu`

Get or set the value of `nu`.

`delta`

Get or set the value of `delta`.

### Methods

#### Method `new()`

New Student distribution.

##### Usage
`Student\$new(nu, delta)`
##### Arguments
`nu`

degrees of freedom parameter, `>0`

`delta`

non-centrality parameter

##### Returns

A `Student` object.

#### Method `d()`

Density function of the Student distribution.

##### Usage
`Student\$d(x)`
`x`

numeric vector

##### Returns

The density evaluated at `x`.

#### Method `p()`

Cumulative distribution function of the Student distribution.

##### Usage
`Student\$p(q, lower = TRUE)`
##### Arguments
`q`

numeric vector of quantiles

`lower`

Boolean, whether to deal with the lower tail

##### Returns

The cumulative probabilities corresponding to `q`.

#### Method `q()`

Quantile function of the Student distribution.

##### Usage
`Student\$q(p, lower = TRUE)`
##### Arguments
`p`

numeric vector of probabilities

`lower`

Boolean, whether to deal with the lower tail

##### Returns

The quantiles corresponding to `p`.

#### Method `r()`

Sampling from the Student distribution.

##### Usage
`Student\$r(n)`
##### Arguments
`n`

number of simulations

##### Returns

A numeric vector of length `n`.

#### Method `mean()`

Mean of the Student distribution.

##### Usage
`Student\$mean()`
##### Returns

The mean of the Student distribution.

#### Method `median()`

Median of the Student distribution.

##### Usage
`Student\$median()`
##### Returns

The median of the Student distribution.

#### Method `mode()`

Mode of the Student distribution.

##### Usage
`Student\$mode()`
##### Returns

The mode of the Student distribution.

#### Method `sd()`

Standard deviation of the Student distribution.

##### Usage
`Student\$sd()`
##### Returns

The standard deviation of the Student distribution.

#### Method `variance()`

Variance of the Student distribution.

##### Usage
`Student\$variance()`
##### Returns

The variance of the Student distribution.

#### Method `skewness()`

Skewness of the Student distribution.

##### Usage
`Student\$skewness()`
##### Returns

The skewness of the Student distribution.

#### Method `kurtosis()`

Kurtosis of the Student distribution.

##### Usage
`Student\$kurtosis()`
##### Returns

The kurtosis of the Student distribution.

#### Method `kurtosisExcess()`

Kurtosis excess of the Student distribution.

##### Usage
`Student\$kurtosisExcess()`
##### Returns

The kurtosis excess of the Student distribution.

#### Method `clone()`

The objects of this class are cloneable with this method.

##### Usage
`Student\$clone(deep = FALSE)`
##### Arguments
`deep`

Whether to make a deep clone.

### Note

The non-centrality parameter of the Student distribution in the stats package is limited to `abs(ncp) <= 37.62`. The present implementation allows a larger range.

boodist documentation built on Aug. 10, 2023, 5:10 p.m.