sp_multi_network-class: Class sp_multi_network

Description Usage Arguments Slots See Also Examples

Description

A S4 class that gathers information on one or multiple networks sp_network_nodes() and origin-destination pairs sp_network_pair(). The class is constructed with the sp_multi_network() function.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
## S4 method for signature 'sp_multi_network'
id(object)

## S4 method for signature 'sp_multi_network'
dat(object, .id)

## S4 method for signature 'sp_multi_network'
neighborhood(object, .id = 1)

## S4 method for signature 'sp_multi_network'
pull_member(object, .id)

Arguments

object

sp_multi_network-class

.id

A character indicating the id of a sp_network_nodes-class() or a sp_network_pair-class() inside the sp_multi_network-class().

Slots

networks

A list of sp_network_nodes-class() objects

network_pairs

A list of sp_network_pair-class() objects

See Also

Other spflow network classes: sp_network_nodes-class, sp_network_pair-class, spflow_network_classes

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
## access the id of a networks or network_pairs inside a multi network

id(multi_net_usa_ge)$networks
id(multi_net_usa_ge)$network_pairs

## access the data of a network or a network_pair inside a multi_network

dat(multi_net_usa_ge, "ge")    # extract data of nodes
dat(multi_net_usa_ge, "ge_ge") # extract data of pairs

## access sp_network_nodes or sp_network_pair inside a sp_multi_network

pull_member(multi_net_usa_ge,"ge")
pull_member(multi_net_usa_ge,"usa")
pull_member(multi_net_usa_ge,"ge_ge")

spflow documentation built on Sept. 9, 2021, 5:06 p.m.