Skip to main content

bactopia-prepare

Create a 'file of filenames' (FOFN) of samples to be processed by Bactopia

Usage

bactopia-prepare [OPTIONS]

Required Options

OptionTypeDefaultDescription
--path, -pSTRINGDirectory where FASTQ files are stored

Matching Options

OptionTypeDefaultDescription
--assembly-ext, -aSTRING.fna.gzExtension of the FASTA assemblies
--fastq-ext, -fSTRING.fastq.gzExtension of the FASTQs
--fastq-separatorSTRING_Split FASTQ name on the last occurrence of the separator
--pe1-patternSTRING`[Aa][Rr]1
--pe2-patternSTRING`[Bb][Rr]2
--mergeBOOLfalseFlag samples with multiple read sets to be merged by Bactopia
--ontBOOLfalseSingle-end reads should be treated as Oxford Nanopore reads
--hybridBOOLfalseSamples with paired and single-end reads will be set to Illumina-first hybrid assembly (requires --ont)
--short-polishBOOLfalseSamples with paired and single-end reads will be set to Nanopore-first hybrid assembly (requires --ont)
--recursive, -rBOOLfalseDirectories will be traversed recursively
--prefixSTRINGPrefix to add to the path

Sample Information Options

OptionTypeDefaultDescription
--metadataSTRINGMetadata per sample with genome size and species information
--genome-size, -gsizeINT0Genome size to use for all samples
--species, -sSTRINGUNKNOWN_SPECIESSpecies to use for all samples (If available, can be used to determine genome size)
--taxidSTRINGUse the genome size of the Taxon ID for all samples

Additional Options

OptionTypeDefaultDescription
--examplesBOOLfalsePrint example usage
--verboseBOOLfalsePrint debug related text
--silentBOOLfalseOnly critical errors will be printed
--version, -VBOOLfalseShow the version and exit.