ch.moralsGetDirOverlapByGrp: A function to get the average directional overlap by group.

ch.moralsGetDirOverlapByGrpR Documentation

A function to get the average directional overlap by group.

Description

This function calculates the average directional overlap by group.

Usage

ch.moralsGetDirOverlapByGrp(data, probe1Col, grpCol = NULL, dirOverlapCol)

Arguments

data

an overlaps dataframe that contains the directional overlaps for all probes (use ch.moralsGetDirOverlapForAllProbes()) and one column with the group name and one column with the probe name (that is the same for all the groups that it belongs to). So, there may be a probe "book" that is the member of three groups "gp1", "gp2", and "gp3". Here, the "book" would be in the probe column, and gp# would be in the group column.

probe1Col

a string the specifies the column name in "data" that contains the first probe item. Only one probe column is needed because all the probes and their reversals are present in the data.

grpCol

a string the specifies the column name in "data" that contains the grouping column. If NULL, there is not grouping. DEFAULT = NULL.

dirOverlapCol

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

Value

a dataframe with the probe in one column, it's average directional overlap in another, its N in another, followed by separate columns containing the average directional overlap and N for each group.

Examples

ch.moralsGetDirOverlapByGrp (overlapData, "probe1", "p1Quant", "dirOverlap")

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