File: Barcode_split.1

package info (click to toggle)
pycoqc 2.5.2%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 98,704 kB
  • sloc: python: 2,295; sh: 165; makefile: 5
file content (55 lines) | stat: -rw-r--r-- 1,987 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
42
43
44
45
46
47
48
49
50
51
52
53
54
55
.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.47.16.
.TH BARCODE_SPLIT "1" "December 2020" "Barcode_split 2.5.2" "User Commands"
.SH NAME
Barcode_split \- simple tool to split sequencing summary report in per barcodes
.SH DESCRIPTION
usage: Barcode_split [\-h] [\-\-version] \fB\-\-summary_file\fR [SUMMARY_FILE ...]
.TP
[\-\-barcode_file [BARCODE_FILE ...]]
[\-\-output_dir OUTPUT_DIR] [\-\-output_unclassified]
[\-\-min_barcode_percent MIN_BARCODE_PERCENT] [\-v | \fB\-q]\fR
.PP
Barcode_split is a simple tool to split sequencing summary report in per
barcodes
.SS "optional arguments:"
.TP
\fB\-h\fR, \fB\-\-help\fR
show this help message and exit
.TP
\fB\-\-version\fR
show program's version number and exit
.TP
\fB\-\-summary_file\fR [SUMMARY_FILE ...], \fB\-f\fR [SUMMARY_FILE ...]
Path to a sequencing_summary generated by Albacore
1.0.0 + (read_fast5_basecaller.py) / Guppy 2.1.3+
(guppy_basecaller). One can also pass multiple space
separated file paths or a UNIX style regex matching
multiple files
.TP
\fB\-\-barcode_file\fR [BARCODE_FILE ...], \fB\-b\fR [BARCODE_FILE ...]
Path to the barcode_file generated by Guppy 2.1.3+
(guppy_barcoder) or Deepbinner 0.2.0+. One can also
pass multiple space separated file paths or a UNIX
style regex matching multiple files
.TP
\fB\-\-output_dir\fR OUTPUT_DIR, \fB\-o\fR OUTPUT_DIR
Folder where to output split barcode data (default:
current dir
.TP
\fB\-\-output_unclassified\fR, \fB\-u\fR
If given, unclassified barcodes are also written in a
file. By default they are skiped
.TP
\fB\-\-min_barcode_percent\fR MIN_BARCODE_PERCENT, \fB\-p\fR MIN_BARCODE_PERCENT
Minimal percent of total reads to retain barcode
label. If below, the barcode value is set as
`unclassified` (default: 0.1)
.TP
\fB\-v\fR, \fB\-\-verbose\fR
Increase verbosity
.TP
\fB\-q\fR, \fB\-\-quiet\fR
Reduce verbosity
.SH AUTHOR
 This manpage was written by Nilesh Patra for the Debian distribution and
 can be used for any other usage of the program.