ch.moralsGetDirOverlapForAllProbes: A function to calculates the directional overlap for all...

ch.moralsGetDirOverlapForAllProbesR Documentation

A function to calculates the directional overlap for all probes.

Description

This function calculates the directional overlap for all probes and ensures every combination is present in both directions (e.g., itemA vs itemB and itemB vs itemA). Thus, there will be duplicate combinations with oppoisite directional overlaps.

Usage

ch.moralsGetDirOverlapForAllProbes(
  data,
  probe1Col,
  probe2Col,
  overlapCol,
  directionCol
)

Arguments

data

a dataframe containing overlap data for probe combinations.

probe1Col

a string the specifies the column name in "data" that contains the first probe item.

probe2Col

a string the specifies the column name in "data" that contains the second probe item.

overlapCol

a string that specifies the name of the column in "data" that contains the overlap column.

directionCol

a string that specifies the name of the column in "data" that contains the direction column that indications the direction of the overlap.

Value

the dataframe (data), doubled in size because it adds the reverse order of the probes, with the directional overlap column (dirOverlap).

Examples

ch.moralsGetDirOverlapForAllProbes (overlapData, "IA1", "IB1", "overlap","direction")

ccpluncw/ccpl_R_chMorals documentation built on Feb. 4, 2024, 3:30 p.m.