settings_class: An S4 class to hold settings for a starve model

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

An S4 class to hold settings for a starve model

Description

An S4 class to hold settings for a starve model

Usage

## S4 method for signature 'settings'
formula(x)

## S4 replacement method for signature 'settings'
formula(x) <- value

## S4 method for signature 'settings'
n_neighbours(x)

## S4 method for signature 'settings'
distance_units(x)

## S4 replacement method for signature 'settings'
distance_units(x) <- value

## S4 method for signature 'settings'
max_distance(x)

## S4 replacement method for signature 'settings'
max_distance(x) <- value

Arguments

x	An object
value	A replacement value

Functions

• formula(settings): Get model formula

• formula(settings) <- value: Set model formula

• n_neighbours(settings): Get maximum number of neighbours used in graphs

• distance_units(settings): Get distance units used for the model.

• distance_units(settings) <- value: Set distance units. Automatically converts max_distance setting to new units.

• max_distance(settings): Get maximum distance for edges in the graph

• max_distance(settings) <- value: Set maximum distance for edges in the graph

Slots

formula

A formula

n_neighbours

The number of parents for each node in the graph.

distance_units

The units used for distance calculation. Must be compatible with units::set_units.

max_distance

The maximum allowable distance for edges in the transient graph.

See Also

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

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