Mercurial > repos > dawe > srf2fastq
comparison srf2fastq/io_lib-1.12.2/man/man1/srf_index_hash.1 @ 0:d901c9f41a6a default tip
Migrated tool version 1.0.1 from old tool shed archive to new tool shed repository
author | dawe |
---|---|
date | Tue, 07 Jun 2011 17:48:05 -0400 |
parents | |
children |
comparison
equal
deleted
inserted
replaced
-1:000000000000 | 0:d901c9f41a6a |
---|---|
1 .TH srf_index_hash 1 "September 29" "" "Staden io_lib" | |
2 | |
3 .SH "NAME" | |
4 | |
5 .PP | |
6 .BR srf_index_hash | |
7 \- Adds a hash-table index to an SRF file. | |
8 | |
9 .SH "SYNOPSIS" | |
10 .PP | |
11 \fBsrf_index_hash\fR [\fI-c] \fIsrf_archive\fR | |
12 | |
13 .SH "DESCRIPTION" | |
14 .PP | |
15 \fBsrf_index_hash\fR adds and index to an SRF file or replaces an | |
16 existing index with a new one. In the case of concatenated SRF files | |
17 only the index at the end of a file will be replaced, but internal | |
18 indices will not be consulted by SRF tools. | |
19 .PP | |
20 The index is a hash table indexing the sequence names only. The name | |
21 itself does not appear in the index, rather the top 7-bits of a 64-bit | |
22 hash key are held in the index along with N-bits used to determine the | |
23 hash bucket. This reduces the index size to around 10-15 bytes per | |
24 sequence. | |
25 | |
26 .SH "OPTIONS" | |
27 .PP | |
28 .TP | |
29 \fB-c\fR | |
30 Check only. This requests that the index is not produced, but the | |
31 checks performed during the creation of an index (such as looking for | |
32 duplicate sequence names) are still performed. | |
33 | |
34 .SH "AUTHOR" | |
35 .PP | |
36 James Bonfield, Wellcome Trust Sanger Institute |