create_node_edge_df: Create dataframe of node and aggregated edge embeddings

Description Usage Arguments Details Value Examples

View source: R/create_node_edge_df.R

Description

Aggregates edge strain and tension to node level

Usage

1
create_node_edge_df(embeddings_data, function_names = c("mean", "median"))

Arguments

embeddings_data

A list. The output of any of the setse embedding functions

function_names

A string vector. the names of the aggregation methods to be used

Details

Often if can be useful to have edge data at node level, an example of this would be plotting the node and tension or strain. To do this requires that the edge embeddings are aggregated somehow to node level and joined to the appropriate node. This function takes as an argument the output of the setse embedding functions and any number of aggregation functions to produce a dataframe that is convenient to use.

Value

A dataframe with node names, node force, node elevation and strain and tension aggregated using the named functions. The strain and tension columns are returned with names in the form "strain_x" where "x" is the name of the function used to aggregate. The total number of columns is dependent on the number of aggregation functions.

Examples

1
2
3
4
5
6
embeddings_data <- biconnected_network %>%
 prepare_edges(.) %>%
 prepare_continuous_force(., node_names = "name", force_var = "force") %>%
 setse_auto(., k = "weight")

out <- create_node_edge_df(embeddings_data, function_names = c("mean", "mode", "sum"))

rsetse documentation built on June 11, 2021, 5:07 p.m.