dag_class: An S4 class to hold a directed acyclic graph with distances.

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

An S4 class to hold a directed acyclic graph with distances.

Description

An S4 class to hold a directed acyclic graph with distances.

Usage

## S4 method for signature 'dag'
edges(x)

## S4 method for signature 'dag'
distances(x)

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

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

## S4 method for signature 'dag'
show(object)

Arguments

x	An object
value	A replacement value
object	An object

Functions

• edges(dag): Get edge list

• distances(dag): Get list of edge distances

• distance_units(dag): Get distance units

• distance_units(dag) <- value: Set distance units. Edge distances are automatically converted to the new units.

• show(dag): Print method

Slots

edges

A list whose elements consist of a "to" vector and a "from" vector. There is a directed edge in the graph from each vertex in "from" to each vertex in "to". If there are multiple vertices in "to" then there are undirected edges between all vertices in "to" (forming a Kn graph).

distances

A list whose elements consist of a distance matrix for the edges in the correponding entry of edges. The rows/columns of the distance matrix are in the same order as the vertices in that edge list, starting with the vertices in "to" and then the vertices in "from".

distance_units

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

See Also

construct_graph Functions used to create graphs.

Other starve_classes: TMB_out-class, long_stars-class, observation_parameters-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.