get_npc: Compute normalized path count similarity.

View source: R/similarity-metrics.R

get_npcR Documentation

Compute normalized path count similarity.

Description

Use the normalized path count metric to compute a meta-path based similarity score.

Usage

get_npc(
  x,
  y,
  paths_x,
  paths_y,
  reference_list = NULL,
  list_type = NULL,
  verbose = TRUE
)

Arguments

x

ID of the origin node.

y

ID of the destination node.

paths_x

Paths from the origin node following the meta-path of interest as a data.table.

paths_y

Paths from the destination node following the meta-path of interest as a data.table.

reference_list

Either an edge list as a data.table which must contain the columns Origin, Destination, OriginType, DestinationType, and EdgeType, or a neighbor reference object constructed by get_neighbor_list().

list_type

If an edge list is provided, specify "edge". If a neighbor list is provided, specify "neighbor".

verbose

Should the intermediate calculations be printed to the console?

Value

A list with two elements:

Metric

The name of the similarity metric (i.e., "Normalized Path Count").

Similarity

The normalized path count similarity score.

References

Himmelstein, D. S. & Baranzini, S. E. Heterogeneous Network Edge Prediction: A Data Integration Approach to Prioritize Disease-Associated Genes. PLOS Computational Biology 11, e1004259 (2015).

See Also

get_neighbor_list() for neighbor reference object construction.

Other similarity: get_dwpc(), get_pathsim(), get_pc()


ayushnoori/metapaths documentation built on March 19, 2023, 7:35 p.m.