inner_t_index_calculation: Calculates time-dependent index when nodes weights or...

In damianobaldan/riverconn: Fragmentation and Connectivity Indices for Riverscapes

Calculates time-dependent index when nodes weights or barriers passability are changing - not for exporting

Description

Calculates time-dependent index when nodes weights or barriers passability are changing - not for exporting

Usage

inner_t_index_calculation(
  graph,
  barriers_metadata,
  id_barrier,
  year,
  pass_u,
  pass_d,
  weights_metadata,
  weight,
  nodes_id,
  parallel,
  ncores,
  index_type,
  index_mode,
  c_ij_flag,
  B_ij_flag,
  dir_fragmentation_type,
  pass_confluence,
  field_B,
  dir_distance_type,
  disp_type,
  param_u,
  param_d,
  param,
  param_l
)

Arguments

graph	an object of class igraph. Can be both directed or undirected.
barriers_metadata	data.frame that must contain a column having the same name as the 'id_barrier' attribute of the graph, and two columns with the corresponding upstream and downstream improved passabilities (see pass_u and pass_d), and a column with the year passability was changed. This data frame can be obtained from easily-formatted data with the function t_passability_sequencer.
id_barrier	graph edges numeric attribute used to label barriers. Default is "id_barrier". It should be present in the 'barriers metadata' input as well.
year	field of the 'barriers metadata' where temporal information on the changes in passabiity is stored.
pass_u	check index_calculation function.
pass_d	check index_calculation function.
weights_metadata	data.frame that must contain a column having the same name as the 'nodes_id' attribute of the graph, a column with he corresponding weight information (see 'weight' parameter), and a column with the year weight was changed. This data frame can be obtained from easily-formatted data with the function t_weight_sequencer.
weight	param weight graph vertex attribute used to assign weights to the reaches (nodes). Default is "length".
nodes_id	graph vertex attribute used to univoquely label reaches (nodes). Default is "name".
parallel	logical value to flag if parallel option is to be used.
ncores	define how many cores are used in parallel processing. Active only when parallel = TRUE
index_type	check index_calculation function.
index_mode	check index_calculation function.
c_ij_flag	check index_calculation function.
B_ij_flag	check index_calculation function.
dir_fragmentation_type	check index_calculation function.
pass_confluence	check index_calculation function.
field_B	check index_calculation function.
dir_distance_type	check index_calculation function.
disp_type	check index_calculation function.
param_u	check index_calculation function.
param_d	check index_calculation function.
param	check index_calculation function.

Value

a data.frame with a 'year' field and related connectity index. If index_type = "reach", the data.frame is organized by 'year' and 'name'.

damianobaldan/riverconn documentation built on April 6, 2024, 1:38 p.m.