observation_parameters_class: An S4 class to hold observation parameters for a starve...

In lawlerem/staRVe: Spatio-Temporal Analysis of Research surVEy data

An S4 class to hold observation parameters for a starve model.

Description

An S4 class to hold observation parameters for a starve model.

Usage

## S4 method for signature 'observation_parameters'
response_distribution(x)

## S4 replacement method for signature 'observation_parameters'
response_distribution(x) <- value

## S4 method for signature 'observation_parameters'
response_parameters(x)

## S4 replacement method for signature 'observation_parameters'
response_parameters(x) <- value

## S4 method for signature 'observation_parameters'
link_function(x)

## S4 replacement method for signature 'observation_parameters'
link_function(x) <- value

## S4 method for signature 'observation_parameters'
fixed_effects(x)

## S4 replacement method for signature 'observation_parameters'
fixed_effects(x) <- value

Arguments

x	An object
value	A replacement value

Functions

• response_distribution(observation_parameters): Get response distribution(s)

• response_distribution(observation_parameters) <- value: Get/set response distribution(s). Run get_starve_distributions("distribution") for valid options. Setting the the response distribution also overwrites the response parameters and link function(s).

• response_parameters(observation_parameters): Get response distribution parameters

• response_parameters(observation_parameters) <- value: Set response distribution parameters

• link_function(observation_parameters): Get link function(s)

• link_function(observation_parameters) <- value: set link function(s). Run get_starve_distributions("link") for valid options.

• fixed_effects(observation_parameters): Get fixed effect parameters

• fixed_effects(observation_parameters) <- value: Set fixed effect parameters

Slots

response_distribution

The response distribution(s), must be one from get_starve_distributions("distribution").

response_parameters

A list containing a data.frame of response distribution parameters for each response variable.

link_function

The link function(s), must be one from get_starve_distributions("link").

fixed_effects

A list containing a data.frame of fixed effect parameters for each response variable.

See Also

Other starve_classes: TMB_out-class, dag-class, long_stars-class, observations-class, parameters-class, process-class, process_parameters-class, settings-class, starve-class, tracing-class

lawlerem/staRVe documentation built on Oct. 9, 2024, 4:48 a.m.