accessors-methods-sspm_dataset: Accessing OR replacing 'sspm_dataset' model elements

In pedersen-fisheries-lab/spaspm: Spatial Surplus Production Model Framework for Northern Shrimp Populations

Accessing OR replacing sspm_dataset model elements

Description

All methods described here allow to access the elements of contained in objects of class sspm_dataset.

Usage

spm_data(sspm_object)

## S4 method for signature 'sspm_dataset'
spm_data(sspm_object)

spm_data(object) <- value

## S4 replacement method for signature 'sspm_dataset'
spm_data(object) <- value

## S4 method for signature 'sspm_dataset'
spm_name(sspm_object)

## S4 replacement method for signature 'sspm_dataset'
spm_name(object) <- value

## S4 method for signature 'sspm_dataset'
spm_unique_ID(sspm_object)

## S4 replacement method for signature 'sspm_dataset'
spm_unique_ID(object) <- value

spm_coords_col(sspm_object)

## S4 method for signature 'sspm_dataset'
spm_coords_col(sspm_object)

spm_coords_col(object) <- value

## S4 replacement method for signature 'sspm_dataset'
spm_coords_col(object) <- value

## S4 method for signature 'sspm_dataset'
spm_time(sspm_object)

## S4 replacement method for signature 'sspm_dataset'
spm_time(object) <- value

spm_biomass_vars(sspm_object)

## S4 method for signature 'sspm_dataset'
spm_biomass_vars(sspm_object)

spm_biomass_vars(object) <- value

## S4 replacement method for signature 'sspm_dataset'
spm_biomass_vars(object) <- value

spm_density_vars(sspm_object)

## S4 method for signature 'sspm_dataset'
spm_density_vars(sspm_object)

spm_density_vars(object) <- value

## S4 replacement method for signature 'sspm_dataset'
spm_density_vars(object) <- value

spm_formulas(sspm_object)

## S4 method for signature 'sspm_dataset'
spm_formulas(sspm_object)

spm_formulas(object) <- value

## S4 replacement method for signature 'sspm_dataset'
spm_formulas(object) <- value

## S4 method for signature 'sspm_dataset'
spm_smoothed_data(sspm_object)

## S4 replacement method for signature 'sspm_dataset'
spm_smoothed_data(object) <- value

spm_smoothed_fit(sspm_object)

## S4 method for signature 'sspm_dataset'
spm_smoothed_fit(sspm_object)

spm_smoothed_fit(object) <- value

## S4 replacement method for signature 'sspm_dataset'
spm_smoothed_fit(object) <- value

spm_smoothed_vars(sspm_object)

## S4 method for signature 'sspm_dataset'
spm_smoothed_vars(sspm_object)

spm_smoothed_vars(object) <- value

## S4 replacement method for signature 'sspm_dataset'
spm_smoothed_vars(object) <- value

is_mapped(sspm_object)

## S4 method for signature 'sspm_dataset'
is_mapped(sspm_object)

is_mapped(object) <- value

## S4 replacement method for signature 'sspm_dataset'
is_mapped(object) <- value

## S4 method for signature 'sspm_dataset'
spm_boundaries(sspm_object)

## S4 replacement method for signature 'sspm_dataset'
spm_boundaries(object) <- value

Arguments

sspm_object	[sspm_dataset] An object of class sspm_dataset.
object	[sspm_dataset] An object of class sspm_dataset.
value	typically an array-like R object of a similar class as x.

Value

The object in the required slot.

Examples

data(borealis_simulated, package = "sspm")
biomass_dataset <- spm_as_dataset(data.frame(borealis_simulated), name = "borealis",
                                  density = "weight_per_km2",
                                  time = "year_f",
                                  coords = c('lon_dec','lat_dec'),
                                  uniqueID = "uniqueID")
spm_data(biomass_dataset)

pedersen-fisheries-lab/spaspm documentation built on Feb. 16, 2025, 7:39 p.m.