2. Command line tools

• 2.1. illumina.py - for raw Illumina outputs
  • 2.1.1. subcommands
  • 2.1.2. Sub-commands
    • 2.1.2.1. illumina_metadata
      • 2.1.2.1.1. Named Arguments
    • 2.1.2.2. splitcode_demux_fastqs
      • 2.1.2.2.1. Named Arguments
    • 2.1.2.3. illumina_demux
      • 2.1.2.3.1. Positional Arguments
      • 2.1.2.3.2. Named Arguments
    • 2.1.2.4. flowcell_metadata
      • 2.1.2.4.1. Positional Arguments
      • 2.1.2.4.2. Named Arguments
    • 2.1.2.5. lane_metrics
      • 2.1.2.5.1. Positional Arguments
      • 2.1.2.5.2. Named Arguments
    • 2.1.2.6. common_barcodes
      • 2.1.2.6.1. Positional Arguments
      • 2.1.2.6.2. Named Arguments
    • 2.1.2.7. guess_barcodes
      • 2.1.2.7.1. Positional Arguments
      • 2.1.2.7.2. Named Arguments
    • 2.1.2.8. miseq_fastq_to_bam
      • 2.1.2.8.1. Positional Arguments
      • 2.1.2.8.2. Named Arguments
    • 2.1.2.9. extract_fc_metadata
      • 2.1.2.9.1. Positional Arguments
      • 2.1.2.9.2. Named Arguments
    • 2.1.2.10. splitcode_demux
      • 2.1.2.10.1. Positional Arguments
      • 2.1.2.10.2. Named Arguments
    • 2.1.2.11. merge_demux_metrics
      • 2.1.2.11.1. Positional Arguments
      • 2.1.2.11.2. Named Arguments
• 2.2. read_utils.py - utilities that manipulate bam and fastq files
  • 2.2.1. subcommands
  • 2.2.2. Sub-commands
    • 2.2.2.1. index_fasta_samtools
      • 2.2.2.1.1. Positional Arguments
      • 2.2.2.1.2. Named Arguments
    • 2.2.2.2. index_fasta_picard
      • 2.2.2.2.1. Positional Arguments
      • 2.2.2.2.2. Named Arguments
    • 2.2.2.3. mkdup_picard
      • 2.2.2.3.1. Positional Arguments
      • 2.2.2.3.2. Named Arguments
    • 2.2.2.4. revert_bam_picard
      • 2.2.2.4.1. Positional Arguments
      • 2.2.2.4.2. Named Arguments
    • 2.2.2.5. picard
      • 2.2.2.5.1. Positional Arguments
      • 2.2.2.5.2. Named Arguments
    • 2.2.2.6. sort_bam
      • 2.2.2.6.1. Positional Arguments
      • 2.2.2.6.2. Named Arguments
    • 2.2.2.7. downsample_bams
      • 2.2.2.7.1. Positional Arguments
      • 2.2.2.7.2. Named Arguments
    • 2.2.2.8. merge_bams
      • 2.2.2.8.1. Positional Arguments
      • 2.2.2.8.2. Named Arguments
    • 2.2.2.9. filter_bam
      • 2.2.2.9.1. Positional Arguments
      • 2.2.2.9.2. Named Arguments
    • 2.2.2.10. fastq_to_bam
      • 2.2.2.10.1. Positional Arguments
      • 2.2.2.10.2. Named Arguments
    • 2.2.2.11. join_paired_fastq
      • 2.2.2.11.1. Positional Arguments
      • 2.2.2.11.2. Named Arguments
    • 2.2.2.12. split_bam
      • 2.2.2.12.1. Positional Arguments
      • 2.2.2.12.2. Named Arguments
    • 2.2.2.13. reheader_bam
      • 2.2.2.13.1. Positional Arguments
      • 2.2.2.13.2. Named Arguments
    • 2.2.2.14. reheader_bams
      • 2.2.2.14.1. Positional Arguments
      • 2.2.2.14.2. Named Arguments
    • 2.2.2.15. rmdup_cdhit_bam
      • 2.2.2.15.1. Positional Arguments
      • 2.2.2.15.2. Named Arguments
    • 2.2.2.16. rmdup_mvicuna_bam
      • 2.2.2.16.1. Positional Arguments
      • 2.2.2.16.2. Named Arguments
    • 2.2.2.17. rmdup_bbnorm_bam
      • 2.2.2.17.1. Positional Arguments
      • 2.2.2.17.2. Named Arguments
    • 2.2.2.18. rmdup_prinseq_fastq
      • 2.2.2.18.1. Positional Arguments
      • 2.2.2.18.2. Named Arguments
    • 2.2.2.19. filter_bam_mapped_only
      • 2.2.2.19.1. Positional Arguments
      • 2.2.2.19.2. Named Arguments
    • 2.2.2.20. novoalign
      • 2.2.2.20.1. Positional Arguments
      • 2.2.2.20.2. Named Arguments
    • 2.2.2.21. novoindex
      • 2.2.2.21.1. Positional Arguments
      • 2.2.2.21.2. Named Arguments
    • 2.2.2.22. align_and_fix
      • 2.2.2.22.1. Positional Arguments
      • 2.2.2.22.2. Named Arguments
    • 2.2.2.23. minimap2_idxstats
      • 2.2.2.23.1. Positional Arguments
      • 2.2.2.23.2. Named Arguments
    • 2.2.2.24. bwamem_idxstats
      • 2.2.2.24.1. Positional Arguments
      • 2.2.2.24.2. Named Arguments
    • 2.2.2.25. extract_tarball
      • 2.2.2.25.1. Positional Arguments
      • 2.2.2.25.2. Named Arguments
    • 2.2.2.26. read_names
      • 2.2.2.26.1. Positional Arguments
      • 2.2.2.26.2. Named Arguments
    • 2.2.2.27. trim_rmdup_subsamp
      • 2.2.2.27.1. Positional Arguments
      • 2.2.2.27.2. Named Arguments
• 2.3. assembly.py - viral sequence assembly from NGS reads
  • 2.3.1. subcommands
  • 2.3.2. Sub-commands
    • 2.3.2.1. assemble_spades
      • 2.3.2.1.1. Positional Arguments
      • 2.3.2.1.2. Named Arguments
    • 2.3.2.2. gapfill_gap2seq
      • 2.3.2.2.1. Positional Arguments
      • 2.3.2.2.2. Named Arguments
    • 2.3.2.3. cluster_references_ani
      • 2.3.2.3.1. Positional Arguments
      • 2.3.2.3.2. Named Arguments
    • 2.3.2.4. skani_contigs_to_refs
      • 2.3.2.4.1. Positional Arguments
      • 2.3.2.4.2. Named Arguments
    • 2.3.2.5. order_and_orient
      • 2.3.2.5.1. Positional Arguments
      • 2.3.2.5.2. Named Arguments
    • 2.3.2.6. impute_from_reference
      • 2.3.2.6.1. Positional Arguments
      • 2.3.2.6.2. Named Arguments
    • 2.3.2.7. refine_assembly
      • 2.3.2.7.1. Positional Arguments
      • 2.3.2.7.2. Named Arguments
    • 2.3.2.8. filter_short_seqs
      • 2.3.2.8.1. Positional Arguments
      • 2.3.2.8.2. Named Arguments
    • 2.3.2.9. modify_contig
      • 2.3.2.9.1. Positional Arguments
      • 2.3.2.9.2. Named Arguments
    • 2.3.2.10. vcf_to_fasta
      • 2.3.2.10.1. Positional Arguments
      • 2.3.2.10.2. Named Arguments
    • 2.3.2.11. trim_fasta
      • 2.3.2.11.1. Positional Arguments
      • 2.3.2.11.2. Named Arguments
    • 2.3.2.12. deambig_fasta
      • 2.3.2.12.1. Positional Arguments
      • 2.3.2.12.2. Named Arguments
    • 2.3.2.13. alignment_summary
      • 2.3.2.13.1. Positional Arguments
      • 2.3.2.13.2. Named Arguments
    • 2.3.2.14. simulate_illumina_reads
      • 2.3.2.14.1. Positional Arguments
      • 2.3.2.14.2. Named Arguments
• 2.4. taxon_filter.py - filter reads by taxonomic membership
  • 2.4.1. subcommands
  • 2.4.2. Sub-commands
    • 2.4.2.1. deplete
      • 2.4.2.1.1. Positional Arguments
      • 2.4.2.1.2. Named Arguments
    • 2.4.2.2. filter_lastal_bam
      • 2.4.2.2.1. Positional Arguments
      • 2.4.2.2.2. Named Arguments
    • 2.4.2.3. deplete_bam_bmtagger
      • 2.4.2.3.1. Positional Arguments
      • 2.4.2.3.2. Named Arguments
    • 2.4.2.4. deplete_blastn_bam
      • 2.4.2.4.1. Positional Arguments
      • 2.4.2.4.2. Named Arguments
    • 2.4.2.5. deplete_bwa_bam
      • 2.4.2.5.1. Positional Arguments
      • 2.4.2.5.2. Named Arguments
    • 2.4.2.6. deplete_minimap2_bam
      • 2.4.2.6.1. Positional Arguments
      • 2.4.2.6.2. Named Arguments
    • 2.4.2.7. lastal_build_db
      • 2.4.2.7.1. Positional Arguments
      • 2.4.2.7.2. Named Arguments
    • 2.4.2.8. bwa_build_db
      • 2.4.2.8.1. Positional Arguments
      • 2.4.2.8.2. Named Arguments
    • 2.4.2.9. blastn_build_db
      • 2.4.2.9.1. Positional Arguments
      • 2.4.2.9.2. Named Arguments
    • 2.4.2.10. bmtagger_build_db
      • 2.4.2.10.1. Positional Arguments
      • 2.4.2.10.2. Named Arguments
• 2.5. metagenomics.py - utilities for metagenomic analyses
  • 2.5.1. subcommands
  • 2.5.2. Sub-commands
    • 2.5.2.1. subset_taxonomy
      • 2.5.2.1.1. Positional Arguments
      • 2.5.2.1.2. Named Arguments
    • 2.5.2.2. filter_taxids_to_focal_hits
      • 2.5.2.2.1. Positional Arguments
      • 2.5.2.2.2. Named Arguments
    • 2.5.2.3. kraken2
      • 2.5.2.3.1. Positional Arguments
      • 2.5.2.3.2. Named Arguments
    • 2.5.2.4. kb
      • 2.5.2.4.1. Positional Arguments
      • 2.5.2.4.2. Named Arguments
    • 2.5.2.5. kma
      • 2.5.2.5.1. Positional Arguments
      • 2.5.2.5.2. Named Arguments
    • 2.5.2.6. kma_build
      • 2.5.2.6.1. Positional Arguments
      • 2.5.2.6.2. Named Arguments
    • 2.5.2.7. krona
      • 2.5.2.7.1. Positional Arguments
      • 2.5.2.7.2. Named Arguments
    • 2.5.2.8. report_merge
      • 2.5.2.8.1. Positional Arguments
      • 2.5.2.8.2. Named Arguments
    • 2.5.2.9. filter_bam_to_taxa
      • 2.5.2.9.1. Positional Arguments
      • 2.5.2.9.2. Named Arguments
    • 2.5.2.10. taxlevel_summary
      • 2.5.2.10.1. Positional Arguments
      • 2.5.2.10.2. Named Arguments
    • 2.5.2.11. taxlevel_plurality
      • 2.5.2.11.1. Positional Arguments
      • 2.5.2.11.2. Named Arguments
    • 2.5.2.12. kb_extract
      • 2.5.2.12.1. Positional Arguments
      • 2.5.2.12.2. Named Arguments
    • 2.5.2.13. kb_top_taxa
      • 2.5.2.13.1. Positional Arguments
      • 2.5.2.13.2. Named Arguments
    • 2.5.2.14. kb_merge_h5ads
      • 2.5.2.14.1. Positional Arguments
      • 2.5.2.14.2. Named Arguments
    • 2.5.2.15. krona_build
      • 2.5.2.15.1. Positional Arguments
      • 2.5.2.15.2. Named Arguments
    • 2.5.2.16. kraken2_build
      • 2.5.2.16.1. Positional Arguments
      • 2.5.2.16.2. Named Arguments
    • 2.5.2.17. kb_build
      • 2.5.2.17.1. Positional Arguments
      • 2.5.2.17.2. Named Arguments
• 2.6. kmer_utils.py - commands for working with sets of kmers
  • 2.6.1. subcommands
  • 2.6.2. Sub-commands
    • 2.6.2.1. build_kmer_db
      • 2.6.2.1.1. Positional Arguments
      • 2.6.2.1.2. Named Arguments
    • 2.6.2.2. dump_kmer_counts
      • 2.6.2.2.1. Positional Arguments
      • 2.6.2.2.2. Named Arguments
    • 2.6.2.3. filter_reads
      • 2.6.2.3.1. Positional Arguments
      • 2.6.2.3.2. Named Arguments
    • 2.6.2.4. kmers_binary_op
      • 2.6.2.4.1. Positional Arguments
      • 2.6.2.4.2. Named Arguments
    • 2.6.2.5. kmers_set_counts
      • 2.6.2.5.1. Positional Arguments
      • 2.6.2.5.2. Named Arguments
• 2.7. interhost.py - SNP calling, multi-alignment, and phylogenetics
  • 2.7.1. subcommands
  • 2.7.2. Sub-commands
    • 2.7.2.1. snpEff
      • 2.7.2.1.1. Positional Arguments
      • 2.7.2.1.2. Named Arguments
    • 2.7.2.2. align_mafft
      • 2.7.2.2.1. Positional Arguments
      • 2.7.2.2.2. Named Arguments
    • 2.7.2.3. multichr_mafft
      • 2.7.2.3.1. Positional Arguments
      • 2.7.2.3.2. Named Arguments
• 2.8. intrahost.py - intrahost variant calling and annotation
  • 2.8.1. subcommands
  • 2.8.2. Sub-commands
    • 2.8.2.1. vphaser_one_sample
      • 2.8.2.1.1. Positional Arguments
      • 2.8.2.1.2. Named Arguments
    • 2.8.2.2. vphaser
      • 2.8.2.2.1. Positional Arguments
      • 2.8.2.2.2. Named Arguments
    • 2.8.2.3. tabfile_rename
      • 2.8.2.3.1. Positional Arguments
      • 2.8.2.3.2. Named Arguments
    • 2.8.2.4. merge_to_vcf
      • 2.8.2.4.1. Positional Arguments
      • 2.8.2.4.2. Named Arguments
    • 2.8.2.5. Fws
      • 2.8.2.5.1. Positional Arguments
      • 2.8.2.5.2. Named Arguments
    • 2.8.2.6. iSNV_table
      • 2.8.2.6.1. Positional Arguments
      • 2.8.2.6.2. Named Arguments
    • 2.8.2.7. iSNP_per_patient
      • 2.8.2.7.1. Positional Arguments
      • 2.8.2.7.2. Named Arguments
• 2.9. ncbi.py - NCBI Genbank and SRA utilities
  • 2.9.1. subcommands
  • 2.9.2. Sub-commands
    • 2.9.2.1. tbl_transfer
      • 2.9.2.1.1. Positional Arguments
      • 2.9.2.1.2. Named Arguments
    • 2.9.2.2. tbl_transfer_multichr
      • 2.9.2.2.1. Positional Arguments
      • 2.9.2.2.2. Named Arguments
    • 2.9.2.3. tbl_transfer_prealigned
      • 2.9.2.3.1. Positional Arguments
      • 2.9.2.3.2. Named Arguments
    • 2.9.2.4. fetch_fastas
      • 2.9.2.4.1. Positional Arguments
      • 2.9.2.4.2. Named Arguments
    • 2.9.2.5. fetch_feature_tables
      • 2.9.2.5.1. Positional Arguments
      • 2.9.2.5.2. Named Arguments
    • 2.9.2.6. fetch_genbank_records
      • 2.9.2.6.1. Positional Arguments
      • 2.9.2.6.2. Named Arguments
    • 2.9.2.7. biosample_to_genbank
      • 2.9.2.7.1. Positional Arguments
      • 2.9.2.7.2. Named Arguments
    • 2.9.2.8. prep_genbank_files
      • 2.9.2.8.1. Positional Arguments
      • 2.9.2.8.2. Named Arguments
    • 2.9.2.9. prep_sra_table
      • 2.9.2.9.1. Positional Arguments
      • 2.9.2.9.2. Named Arguments
• 2.10. reports.py - produce various metrics and reports
  • 2.10.1. subcommands
  • 2.10.2. Sub-commands
    • 2.10.2.1. assembly_stats
      • 2.10.2.1.1. Positional Arguments
      • 2.10.2.1.2. Named Arguments
    • 2.10.2.2. coverage_only
      • 2.10.2.2.1. Positional Arguments
      • 2.10.2.2.2. Named Arguments
    • 2.10.2.3. consolidate_fastqc
      • 2.10.2.3.1. Positional Arguments
      • 2.10.2.3.2. Named Arguments
    • 2.10.2.4. consolidate_spike_count
      • 2.10.2.4.1. Positional Arguments
      • 2.10.2.4.2. Named Arguments
    • 2.10.2.5. aggregate_spike_count
      • 2.10.2.5.1. Positional Arguments
      • 2.10.2.5.2. Named Arguments
    • 2.10.2.6. aggregate_alignment_counts
      • 2.10.2.6.1. Positional Arguments
      • 2.10.2.6.2. Named Arguments
    • 2.10.2.7. plot_coverage
      • 2.10.2.7.1. Positional Arguments
      • 2.10.2.7.2. Named Arguments
    • 2.10.2.8. align_and_plot_coverage
      • 2.10.2.8.1. Positional Arguments
      • 2.10.2.8.2. Named Arguments
    • 2.10.2.9. fastqc
      • 2.10.2.9.1. Positional Arguments
      • 2.10.2.9.2. Named Arguments
• 2.11. file_utils.py - utilities to perform various file manipulations
  • 2.11.1. subcommands
  • 2.11.2. Sub-commands
    • 2.11.2.1. merge_tarballs
      • 2.11.2.1.1. Positional Arguments
      • 2.11.2.1.2. Named Arguments
    • 2.11.2.2. rename_fasta_sequences
      • 2.11.2.2.1. Positional Arguments
      • 2.11.2.2.2. Named Arguments
    • 2.11.2.3. tsv_derived_cols
      • 2.11.2.3.1. Positional Arguments
      • 2.11.2.3.2. Named Arguments
    • 2.11.2.4. tsv_join
      • 2.11.2.4.1. Positional Arguments
      • 2.11.2.4.2. Named Arguments
• 2.12. broad_utils.py - for data generated at the Broad Institute
  • 2.12.1. subcommands
  • 2.12.2. Sub-commands
    • 2.12.2.1. get_bustard_dir
      • 2.12.2.1.1. Positional Arguments
      • 2.12.2.1.2. Named Arguments
    • 2.12.2.2. get_run_date
      • 2.12.2.2.1. Positional Arguments
      • 2.12.2.2.2. Named Arguments
    • 2.12.2.3. get_all_names
      • 2.12.2.3.1. Positional Arguments
      • 2.12.2.3.2. Named Arguments