read_genome: Read genome files.

Description Usage Arguments Value Note See Also Examples

View source: R/read_genome.r

Description

Genome files (UCSC "chromSize" files) contain chromosome name and size information. These sizes are used by downstream functions to identify computed intervals that have coordinates outside of the genome bounds.

Usage

1

Arguments

path

containing chrom/contig names and sizes, one-pair-per-line, tab-delimited

Value

genome_df, sorted by size

Note

URLs to genome files can also be used.

See Also

Other read functions: read_bed(), read_vcf()

Examples

1
2
3
4
5
6
7
read_genome(valr_example('hg19.chrom.sizes.gz'))

## Not run: 
# `read_genome` accepts a URL
read_genome('https://genome.ucsc.edu/goldenpath/help/hg19.chrom.sizes')

## End(Not run)

valr documentation built on Dec. 11, 2021, 9:57 a.m.