filter_methods: Access or modify the 'filter' parameters of...

In moshejasper/kindisperse: Simulate and Estimate Close-Kin Dispersal Kernels

Access or modify the filter parameters of KinPairSimulation objects

Description

These generics & methods work as an interface between KinPairSimulation objects and the sample_kindist function. They either retrieve the value of pre-existing filter steps that have been applied to the object (e.g. upper(x)) or assign such a filtering parameter to the KinPairSimulation object (e.g. sampledims(x) <- value). In this case, the method passes the KinPairSimulation object to the sample_kindist() function for subsampling or filtering, then updates the sampling parameter before returning the modified object. Note that while the sample_kindist function can take KinPairData objects, the methods described here are only applicable to objects of class KinPairSimulation.

Usage

upper(x)

upper(x) <- value

lower(x)

lower(x) <- value

spacing(x)

spacing(x) <- value

samplenum(x)

samplenum(x) <- value

sampledims(x)

sampledims(x) <- value

## S4 method for signature 'KinPairSimulation'
upper(x)

## S4 method for signature 'KinPairSimulation'
lower(x)

## S4 method for signature 'KinPairSimulation'
spacing(x)

## S4 method for signature 'KinPairSimulation'
samplenum(x)

## S4 method for signature 'KinPairSimulation'
sampledims(x)

## S4 replacement method for signature 'KinPairSimulation'
upper(x) <- value

## S4 replacement method for signature 'KinPairSimulation'
lower(x) <- value

## S4 replacement method for signature 'KinPairSimulation'
spacing(x) <- value

## S4 replacement method for signature 'KinPairSimulation'
samplenum(x) <- value

## S4 replacement method for signature 'KinPairSimulation'
sampledims(x) <- value

Arguments

x	object of class KinPairSimulation
value	value for parameter to be adjusted to
KinPairSimulation	object of class KinPairSimulation

Value

either the accessed numeric filter parameter or a filtered KinPairSimulation object

Functions

• upper(KinPairSimulation):

• lower(KinPairSimulation):

• spacing(KinPairSimulation):

• samplenum(KinPairSimulation):

• sampledims(KinPairSimulation):

• upper(KinPairSimulation) <- value:

• lower(KinPairSimulation) <- value:

• spacing(KinPairSimulation) <- value:

• samplenum(KinPairSimulation) <- value:

• sampledims(KinPairSimulation) <- value:

See Also

Other kpsmethods: access_sigmas, kernelshape(), kerneltype(), simtype()

moshejasper/kindisperse documentation built on Oct. 25, 2024, 2:57 a.m.