read_fasta {jackalope}

Read a fasta file.

Description

Accepts uncompressed and gzipped fasta files.

Usage

read_fasta(fasta_files, fai_files = NULL, cut_names = FALSE)

Arguments

fasta_files

File name(s) of the fasta file(s).

fai_files

File name(s) of the fasta index file(s). Providing this argument speeds up the reading process significantly. If this argument is provided, it must be the same length as the fasta_files argument. Defaults to NULL, which indicates the fasta file(s) is/are not indexed.

cut_names

Boolean for whether to cut chromosome names at the first space. This argument is ignored if fai_file is not NULL. Defaults to FALSE.

Value

A ref_genome object.