Extract summary stats for temporal network node properties, in parallel
parallel_summarise_temporal_node_properties.Rd
parallel_summarise_temporal_node_properties()
calculates summary statistics
for a selected node property, over a list of networks. Optionally, identifiers
of the nodes with maximum values of the selected node property can also be
returned. This function uses a socket cluster with n_threads
threads to
run calculations in parallel.
Usage
parallel_summarise_temporal_node_properties(
networks,
n_threads,
node_property,
statistics,
identify_nodes = FALSE
)
Arguments
- networks
A list containing movement networks (networkDynamic objects)
- n_threads
Numeric indicating number of threads over which to parallelise.
- node_property
Character indicating the network metric for which to calculate summary statistics. One of
"forward reachability"
,"temporal degree"
,"temporal indegree"
, or"temporal outdegree"
.- statistics
A list with summary function(s) to calculate for the selected
node_property
. For example,list(median, max = max)
.- identify_nodes
A logical indicating whether you want to identify the nodes with maximal values for
node_property
in each network. Default isFALSE
. Requires thatmax
is included as a named function withinstatistics
.
Value
A named list of lists. For each network, a list consisting of: (1) a
named list summary_statistics
, with the selected node property summary
statistic(s), (2 - only if identify_nodes
is set as TRUE
) a named
character vector node_pid_with_max_value
, with the persistent
identifier(s) of the node(s) with maximal value(s) for the selected node
property.
See also
Other network-related functions:
create_temporal_network_analysis_report()
,
movedata2igraph()
,
movedata2networkDynamic()
,
trace_contact_chains()