R/compare-sets.R
compare_mps.Rd
Given a series of specified meta-path(s), similarity metric(s), and aggregation method(s), compute the meta-path based similarity score between two nodes.
compare_mps( set1, set2, mps, metric = c("pc", "pathsim", "npc", "dwpc"), method = c("maximum"), node_list, edge_list = NULL, neighbor_list = NULL, check = TRUE, verbose = TRUE )
set1 | IDs of node set #1 as a vector. |
---|---|
set2 | IDs of node set #2 as a vector. |
mps | List of meta-paths, where each meta-path is a vector of node types (e.g., |
metric | A vector of permissible similarity metrics (e.g.,
|
method | A vector of permissible aggregation methods (e.g.,
|
node_list | Node list as a
|
edge_list | Edge list as a
|
neighbor_list | Neighbor reference object constructed by |
check | Should type checking be performed? Default is |
verbose | Should the intermediate calculations be printed to the console? |
A list with six elements:
IDs of node set #1 provided (i.e., set1
).
ID of node set #2 provided (i.e., set2
).
Intermediate computations produced by get_similarity()
and compare_sets()
.
Aggregate set similarity score(s).
get_neighbor_list()
for neighbor reference object construction,
get_similarity_function()
for similarity metrics, and
get_aggregation_function()
for aggregation methods. This function is a
wrapper around compare_sets()
, which in turn is a wrapper around get_similarity()
.