annotReciprocal: annotReciprocal

annotReciprocalR Documentation

annotReciprocal

Description

This function notes edges of a graph as reciprocal or not.

Usage

  annotReciprocal(dataGraph, file,
    keepOnlyReciprocal = FALSE)

Arguments

dataGraph

data.frame which contains the graph description, must have two columns n1 and n2 filled with node IDs, each row denoting there is an edge from n1 to n2.

file

file where the graph description is written

keepOnlyReciprocal

if TRUE dataGraph is restricted to reciprocal edges, else all edges are kept (default).

Value

This function returns the argument dataGraph with an additional column named 'reciprocal' which contains TRUE if the edge described by the row is reciprocal, and FALSE if it is not reciprocal.

Author(s)

Anne Biton

Examples

dg <- data.frame(n1=c("A","B","B","C","C","D","E","F"),n2=c("B","G","A","B","D","C","F","E"))
annotReciprocal(dataGraph=dg)

bitona/MineICA documentation built on April 23, 2023, 1:41 p.m.