ch.getOverlapFile: A function to extract a subset of overlaps from a file

View source: R/ch.getOverlapFile.r

ch.getOverlapFileR Documentation

A function to extract a subset of overlaps from a file

Description

A function to extract a subset of overlaps from a file

Usage

ch.getOverlapFile(
  overlapFile = NULL,
  itemFile = NULL,
  outputFile = NULL,
  itemColumn1 = "item1vector",
  itemColumn2 = "item2vector"
)

Arguments

overlapFile

a tab delimited file of a full set of overlaps with all the items.

itemFile

a vector of items that you want to extract the overlaps for.

outputFile

the filename that you want the output written to. DEFAULT = NULL (no file written)

itemColumn1

the name of the column that contains one set of item values in the overlap. DEFAULT = "item1vector"

itemColumn2

the name of the column that contains the second set of item values in the overlap. DEFAULT = "item2vector"

Value

a dataframe with the overlaps statistics for the items in itemFile

Examples

ch.getOverlapFile (Overlaps.txt, items.txt,output.txt)

ccpluncw/ccpl_R_chValues documentation built on Feb. 12, 2024, 4:21 a.m.