R: R6 class for object to use as a worker with 'CoxMaster'...

CoxWorker {distcomp} | R Documentation

## R6 class for object to use as a worker with `CoxMaster` master objects

### Description

`CoxWorker` objects are worker objects at each data site of a distributed Cox model computation

### Methods

#### Public methods

- `CoxWorker$new()`

- `CoxWorker$getP()`

- `CoxWorker$getStateful()`

- `CoxWorker$logLik()`

- `CoxWorker$var()`

- `CoxWorker$kosher()`

- `CoxWorker$clone()`

#### Method `new()`

Create a new `CoxWorker` object.

##### Usage

    CoxWorker$new(defn, data, stateful = TRUE)

##### Arguments

`defn`

  the computation definition

`data`

  the local data

`stateful`

  a boolean flag indicating if state needs to be preserved between REST calls

##### Returns

a new `CoxWorker` object

#### Method `getP()`

Return the dimension of the parameter vector.

##### Usage

    CoxWorker$getP(...)

##### Arguments

`...`

  other args ignored

##### Returns

the dimension of the parameter vector

#### Method `getStateful()`

Return the stateful status of the object.

##### Usage

    CoxWorker$getStateful()

##### Returns

the stateful flag, `TRUE` or `FALSE`

#### Method `logLik()`

Return the partial log likelihood on local data for given `beta` parameter.

##### Usage

    CoxWorker$logLik(beta, ...)

##### Arguments

`beta`

  the parameter vector

`...`

  further arguments, currently unused

##### Returns

a named list with three components: `value` contains the value of the log likelihood, `gradient` contains the score vector, and `hessian` contains the estimated hessian matrix

#### Method `var()`

Return the variance of estimate for given `beta` parameter on local data.

##### Usage

    CoxWorker$var(beta, ...)

##### Arguments

`beta`

  the parameter vector

`...`

  further arguments, currently unused

##### Returns

variance vector

#### Method `kosher()`

Check if inputs and state of object are sane. For future use

##### Usage

    CoxWorker$kosher()

##### Returns

`TRUE` or `FALSE`

#### Method `clone()`

The objects of this class are cloneable with this method.

##### Usage

    CoxWorker$clone(deep = FALSE)

##### Arguments

`deep`

  Whether to make a deep clone.

### See Also

`CoxMaster` which goes hand-in-hand with this object

[Package distcomp version 1.3-1 Index]