R: Shorten the Gene Description

shortenGeneDescription {scrime}

R Documentation

Shorten the Gene Description

Description

Shortens the entries of the column of a data frame containing the genes associated with the SNPs for which the data frame comprises annotations. Typically used in combination with, i.e.\ either within or after an application of, buildSNPannotation.

Usage

  shortenGeneDescription(dat, colname = "Gene", max.length = 2, 
     sep = "///", add.ldots = TRUE)

Arguments

`dat`	a data frame. Typically, the output of `buildSNPannotation`.
`colname`	character string comprising the name of the column of `dat` containing the gene description.
`max.length`	integer specifying the maximum number of genes associated with the respective SNP that should be stored in the data frame. By default, the first two genes are retained. Shortened entries are marked by `...` at the end of the entries, when `add.ldots = TRUE`.
`sep`	character string specifying the separation symbol between the different genes.
`add.ldots`	should `...` be added at the entries which are shortened?

Value

The same data frame as dat with shortened entries in the column of dat named colname.

Author(s)