File: filtlong.1

package info (click to toggle)
filtlong 0.2.1-5
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 3,676 kB
  • sloc: cpp: 3,458; python: 996; sh: 119; makefile: 38
file content (83 lines) | stat: -rw-r--r-- 2,235 bytes parent folder | download | duplicates (4)
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
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.47.8.
.TH FILTLONG "1" "January 2019" "filtlong 0.2.0" "User Commands"
.SH NAME
filtlong \- quality filtering tool for Nanopore and PacBio reads
.SH SYNOPSIS
.B filtlong
{OPTIONS} [input_reads]
.SH OPTIONS
.SS "positional arguments:"
.TP
input_reads
input long reads to be filtered
.SS "optional arguments:"
.IP
output thresholds:
.TP
\fB\-t[int]\fR, \fB\-\-target_bases\fR [int]
keep only the best reads up to this many total bases
.TP
\fB\-p[float]\fR, \fB\-\-keep_percent\fR [float]
keep only this percentage of the best reads (measured by bases)
.TP
\fB\-\-min_length\fR [int]
minimum length threshold
.TP
\fB\-\-min_mean_q\fR [float]
minimum mean quality threshold
.TP
\fB\-\-min_window_q\fR [float]
minimum window quality threshold
.IP
external references (if provided, read quality will be determined using these instead of from the Phred scores):
.TP
\fB\-a[file]\fR, \fB\-\-assembly\fR [file]
reference assembly in FASTA format
.TP
\fB\-1[file]\fR, \fB\-\-illumina_1\fR [file]
reference Illumina reads in FASTQ format
.TP
\fB\-2[file]\fR, \fB\-\-illumina_2\fR [file]
reference Illumina reads in FASTQ format
.IP
score weights (control the relative contribution of each score to the final read score):
.TP
\fB\-\-length_weight\fR [float]
weight given to the length score (default: 1)
.TP
\fB\-\-mean_q_weight\fR [float]
weight given to the mean quality score (default: 1)
.TP
\fB\-\-window_q_weight\fR [float]
weight given to the window quality score (default: 1)
.IP
read manipulation:
.TP
\fB\-\-trim\fR
trim non\-k\-mer\-matching bases from start/end of reads
.TP
\fB\-\-split\fR [split]
split reads at this many (or more) consecutive non\-k\-mer\-matching bases
.IP
other:
.TP
\fB\-\-window_size\fR [int]
size of sliding window used when measuring window quality (default: 250)
.TP
\fB\-\-verbose\fR
verbose output to stderr with info for each read
.TP
\fB\-\-version\fR
display the program version and quit
.TP
\fB\-h\fR, \fB\-\-help\fR
display this help menu
.PP
For
more
information,
go
to:
https://github.com/rrwick/Filtlong
.SH AUTHOR
This manpage was written by Andreas Tille for the Debian distribution and can be used for any other usage of the program.