readucks - Nanopore read de-multiplexer (read demux -> readux
-> readucks, innit)
usage: readucks -i INPUT_PATH [-o OUTPUT_DIR] [-b] [-a]
[-e] [-s] [-m MODE]
- [-p PREFIX] [-t THREADS] [-n NUM_READS_IN_BATCH] [--check_reads
CHECK_READS] [--adapter_threshold ADAPTER_THRESHOLD] [-v VERBOSITY]
[--require_two_barcodes] [--report_alternate_call] [--native_barcodes]
[--pcr_barcodes] [--rapid_barcodes] [--limit_barcodes_to LIMIT_BARCODES_TO
[LIMIT_BARCODES_TO ...]] [--threshold THRESHOLD] [--secondary_threshold
SECONDARY_THRESHOLD] [--score_diff SCORE_DIFF] [--scoring_scheme
SCORING_SCHEME] [-h] [--version]
Readucks: a simple demuxing tool for nanopore data.
- -i INPUT_PATH, --input
INPUT_PATH
- FASTQ of input reads or a directory which will be recursively searched for
FASTQ files (required).
- -o OUTPUT_DIR,
--output_dir OUTPUT_DIR
- Output directory (default: working directory)
- -b,
--bin_barcodes
- Reads will be binned based on their barcode and saved to separate files.
(default: False)
- -a,
--annotate_files
- Writes a CSV file for each input file containing barcode calls for each
read. (default: False)
- -e,
--extended_info
- Writes extended information about barcode calls. (default: False)
- -s,
--summary_info
- Writes another file with information about barcode calls. (default:
False)
- -m MODE, --mode
MODE
- Demuxing mode, one of ["stringent","lenient",
"porechop"]. (default: porechop)
- -p PREFIX, --prefix
PREFIX
- Optional prefix to file names
- -t THREADS, --threads
THREADS
- The number of threads to use (1 to turn off multithreading) (default:
2)
- -n NUM_READS_IN_BATCH,
--num_reads_in_batch NUM_READS_IN_BATCH
- The number of reads to process (and hold in memory) at a time (default:
200)
- --check_reads
CHECK_READS
- Number of barcodes to classify before filtering barcode set (default:
1000)
- --adapter_threshold
ADAPTER_THRESHOLD
- Identity required for a barcode to be included after filtering (default:
90)
- -v VERBOSITY,
--verbosity VERBOSITY
- Level of output information: 0 = none, 1 = some, 2 = lots (default:
1)
This manpage was written by Nilesh Patra for the Debian
distribution and
can be used for any other usage of the program.