spflow (version 0.1.0)

pair_merge: Generic for merging information on origins and destination to node pairs inside spflow network classes

Description

For details on the methods see the documentation of the corresponding classes.

The method merges all available information on origins and destinations to the data.frame describing the pairs.

Usage

pair_merge(object, ...)
# S4 method for sp_multi_network
pair_merge(object, network_pair_id, all_pairs = FALSE)

Arguments

object

A sp_multi_network-class()

...

Arguments to be passed to methods

network_pair_id

A character indicating the id of a sp_network_pair-class()

all_pairs

A logical, when set to TRUE the resulting data.frame contains all possible pairs of origins and destination, even if the data in the sp_network_pair-class() does not have them.

Value

A single data.frame, combining all available information on origins, destinations and OD pairs

See Also

sp_multi_network-class()

Examples

# NOT RUN {
# long form data for flows from Germany to Germany
pair_merge(multi_net_usa_ge,"ge_ge")

# long form data for flows from Germany to USA
pair_merge(multi_net_usa_ge,"ge_usa")
# }