File: sambamba-index.1.ronn

package info (click to toggle)
sambamba 1.0%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 3,528 kB
  • sloc: sh: 220; python: 166; ruby: 147; makefile: 103
file content (41 lines) | stat: -rw-r--r-- 1,237 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
sambamba-index(1) -- tool for building standard index files for BAM data
========================================================================

## SYNOPSIS

`sambamba index` [`-p`|`--show-progress`] [`-t`|`--nthreads`=NTHREADS] <input.bam> [<output.bai>]

## DESCRIPTION

`sambamba index` builds an index for a sorted by coordinate BAM file.
This step is required for effective region querying in most tools for working
with BAM data.

An index is by default written to the file with the same filename except 
`.bai` extension added to the end. The user can, however, override this default
by providing desired output filename explicitly as an optional command-line 
argument.

## OPTIONS

  * `-p`, `--show-progress`:
    Show a wget-like progressbar in STDERR.

  * `-t`, `--nthreads`=<NTHREADS>:
    Number of threads to use.

## EXAMPLES

Build index file example.bam.bai given a sorted BAM file example.bam:

  $ sambamba index example.bam

Build index file at custom location showing progress:

  $ sambamba index --show-progress example.bam /tmp/example.bam.bai

## SEE ALSO

For more information on the original samtools INDEX behaviour, check
out the [samtools documentation](http://samtools.sourceforge.net/samtools.shtml)