RCircos.Validate.Cyto.Info: Validate Chromosome Ideogram Information

View source: R/RCircosChromosomeIdeogram.R

RCircos.Validate.Cyto.InfoR Documentation

Validate Chromosome Ideogram Information

Description

Validate chromosome ideogram information for correct chromosome order including of correct order of chromosome names, chromosome start, and end positions. The prefix of "chr" in chromosome names is no longer required version 1.2.

Usage

RCircos.Validate.Cyto.Info(cyto.info=NULL, chr.exclude=NULL, is.sorted=TRUE)

Arguments

cyto.info

A data frame with chromosome ideogram data, e.g., an object returned by function of read.table() which read a file containing full information of cytoBandIdeo table from UCSC genome browser.

chr.exclude

Character vector, name(s) of chromosomes to be excluded from RCircos plot.

is.sorted

Logic, whether the cyto.info has been sorted.

Value

A data frame with validated chromosome ideogram table.

Author(s)

Henry Zhang

Examples

## Not run: 
library(RCircos)
data(UCSC.HG38.Human.CytoBandIdeogram)
cyto.info <- RCircos.Validate.Cyto.Info(
    cyto.info=UCSC.HG38.Human.CytoBandIdeogram,
    chr.exclude=NULL, is.sorted=FALSE)

## End(Not run)

RCircos documentation built on March 18, 2022, 7:59 p.m.