bam_index: Bam Index

In selkamand/utilitybeltrefseq: What the Package Does (One Line, Title Case)

Bam Index

Description

Index a bam file

Usage

bam_index(path_to_sorted_bam, threads = parallel::detectCores())

Arguments

path_to_sorted_bam	path to a coordinate sorted bam file (string)
threads	number of cores to use for multithreading (int)

Details

Produce a bai index for a sorted bam. Requires samtools to be installed.

Value

path to sorted bam (string)

Examples

## Not run: 
bam_index("path/to/sorted/bam")

## End(Not run)

selkamand/utilitybeltrefseq documentation built on July 7, 2022, 7:35 a.m.