Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Seed of a man page #6

Open
smoe opened this issue Jul 18, 2013 · 0 comments
Open

Seed of a man page #6

smoe opened this issue Jul 18, 2013 · 0 comments

Comments

@smoe
Copy link
Contributor

smoe commented Jul 18, 2013

One of the bits created for the Debian package. Enjoy.

Steffen

.TH GRABIX 1 "July 18, 2013"
.SH NAME
grabix - program to do something
.SH SYNOPSIS
.B bgzip
.RI bedfile
.br
.B grabix
index
.RI bedfile.gz
.br
.B grabix
grab
.RI bedfile.gz
.RI linenumber

.SH DESCRIPTION
.PP
In biomedical research it is increasing practice to study
the genetic basis of disease. This now frequently comprises
the sequencing of human sequences. The output of the machine
however is redundant, and the real sequence is the best
sequence to explain the redundancy. The exchange of data
happens only with compressed files - to huge and redundant
to perform otherwise. One should avoid uncompression whenever
possible.
.PP
grabix leverages the fantastic BGZF library of the samtools
package to provide random access into text files that have
been compressed with bgzip. grabix creates it's own index
(.gbi) of the bgzipped file. Once indexed, one can extract
arbitrary lines from the file with the grab command. Or
choose random lines with the, well, random command.

.SH SEE ALSO
.BR https://github.com/arq5x/grabix

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant