GREP2 (version 1.0.2)

build_index: Build index for mapping using Salmon

Description

build_index for mapping reads using Salmon.

Usage

build_index(species = c("human", "mouse", "rat"), kmer = 31,
  ens_release = 92, destdir)

Arguments

species

name of the species. Only 'human', 'mouse', and 'rat' are allowed to use.

kmer

k-mer size for indexing. default is 31. See 'Salmon' for details.

ens_release

version of Ensembl release.

destdir

directory where all the files will be saved.

Value

directory of index files

References

Rob Patro, Geet Duggal, Michael I. Love, Rafael A. Irizarry, and Carl Kingsford (2017): Salmon provides fast and bias-aware https://www.nature.com/articles/nmeth.4197

Examples

# NOT RUN {
#Running this function will take some time.
# }
# NOT RUN {
build_index(species="human",kmer=31,
ens_release=92,destdir=tempdir())
# }
# NOT RUN {
# }