bacannot
Generic but comprehensive pipeline for prokaryotic genome annotation and interrogation with interactive reports and shiny app.
File Explorer
Download Latest Version (.zip)- bug_report.md
- feature_request.md
- test_pr_docker.yml
- aro_index.tsv
- addBedtoolsIntersect.R
- addBlast2Gff.R
- addCardDescription.R
- addKO2Gff.R
- addNCBIamr2Gff.R
- addRGI2gff.R
- amrfinder2tsv.R
- build_image.sh
- calculate_methylation_frequency.py
- config.yml
- draw_gis.sh
- gbk2faa.py
- GCcalc.py
- gff2sql.R
- input.fofn
- installPack.R
- mlst-make_blast_db.sh
- reduceRepeatedValues.R
- resfinder2gff.py
- run_blasts.py
- run_jbrowse.sh
- splitgenbank.pl
- splitgenbank.py
- tolower.R
- vfdb2tsv.R
- write_gff.R
- write_table_from_gff.R
- awsbatch.config
- base.config
- defaults.config
- docker.config
- singularity.config
- small_dataset_test_profile.config
- standard.config
- test_profile.config
- build.sh
- Dockerfile
- build.sh
- Dockerfile
- argminer.fasta
- victors_06-2022.fasta
- build.sh
- custom_fix_grange_digis.py
- Dockerfile
- no-results-empty-state.jpg
- no_AMRfinder.Rmd
- no_argminer.Rmd
- no_digis.Rmd
- no_ice.Rmd
- no_integronfinder.Rmd
- no_phast.Rmd
- no_phigaro.Rmd
- no_phispy.Rmd
- no_plasmids.Rmd
- no_prophages.Rmd
- no_Resfinder.Rmd
- no_RGI.Rmd
- no_vfdb.Rmd
- no_victors.Rmd
- report_custom_blast.Rmd
- report_general.Rmd
- report_MGEs.Rmd
- report_resistance.Rmd
- report_virulence.Rmd
- reports.Rproj
- styles.css
- victors_metadata.tsv
- yes_AMRfinder.Rmd
- yes_argminer.Rmd
- yes_digis.Rmd
- yes_ice.Rmd
- yes_integronfinder.Rmd
- yes_kegg.Rmd
- yes_ncbi.Rmd
- yes_phast.Rmd
- yes_phigaro.Rmd
- yes_phispy.Rmd
- yes_plasmids.Rmd
- yes_prophages.Rmd
- yes_Resfinder.Rmd
- yes_RGI.Rmd
- yes_sourmash.Rmd
- yes_vfdb.Rmd
- yes_victors.Rmd
- run_jbrowse.sh
- run_server.sh
- resfinder2gff.py
- run_blasts.py
- splitgenbank.py
- addBlast2Gff.R
- addCardDescription.R
- addKO2Gff.R
- addNCBIamr2Gff.R
- addResfinder.R
- addRGI2gff.R
- correctSourceAndFeature.R
- installPack.R
- reduceRepeatedValues.R
- tolower.R
- write_gff.R
- write_table_from_gff.R
- build.sh
- Dockerfile
- blast_app.R
- get_attributes_field.R
- server_entry.sh
- shiny_parser.Rmd
- shiny_parser_func.R
- SQL_parser.R
- build.sh
- Dockerfile
- generate_dockers.sh
- set_version.sh
- bacannot_server_blast.png
- bacannot_server_blast_sequenceserver.png
- bacannot_server_home.png
- bacannot_server_sqldb.png
- bacannot_shiny.gif
- ecoli_kegg-decoder_heatmap-static.svg
- example_circos.png
- jbrowse.png
- nf-core-bacannot-compare_logo_dark.png
- nf-core-config.png
- nf-core-launch.png
- report_general.html
- report_MGEs.html
- report_resistance.html
- report_virulence.html
- extra.css
- config.md
- custom-db.md
- defaults.config
- index.md
- installation.md
- lab_logo.png
- manual.md
- outputs.md
- profiles.md
- quickstart.md
- requirements.txt
- samplesheet.md
- lOGO_3.png
- nf-core-asking.png
- nf-core-gui.png
- nfcore_external_java_deps.jar
- NfcoreSchema.groovy
- NfcoreTemplate.groovy
- Utils.groovy
- WorkflowBacannot.groovy
- WorkflowMain.groovy
- CHANGELOG.md
- earlier_releases_instructions.md
- list_of_tools.md
- flye.nf
- unicycler.nf
- amrfinder.nf
- antismash.nf
- argminer.nf
- card.nf
- get_zenodo.nf
- iceberg.nf
- kofamscan.nf
- mlst.nf
- phast.nf
- phigaro.nf
- plasmidfinder.nf
- platon.nf
- prokka.nf
- resfinder.nf
- sourmash.nf
- vfdb.nf
- victors.nf
- antismash.nf
- bakta.nf
- barrnap.nf
- circos.nf
- compute_gc.nf
- custom_database.nf
- custom_database_report.nf
- gc_skew.nf
- gff2gbk.nf
- gff2sql.nf
- jbrowse.nf
- karyotype.nf
- mash.nf
- merge_annotations.nf
- merge_summaries.nf
- methylation.nf
- mlst.nf
- ncbi_genome.nf
- ncbi_protein.nf
- prepare_circos.nf
- prokka.nf
- reports.nf
- sequenceserver.nf
- sourmash_all.nf
- sourmash_lca.nf
- summary.nf
- kegg-decoder.nf
- kofamscan.nf
- digIS.nf
- draw_gis.nf
- iceberg.nf
- integron_finder.nf
- integron_finder_2gff.nf
- islandpath.nf
- mob_suite.nf
- plasmidfinder.nf
- platon.nf
- phast.nf
- phigaro.nf
- phispy.nf
- amrfinder.nf
- amrfinder2tsv.nf
- argminer.nf
- resfinder.nf
- rgi_annotation.nf
- vfdb.nf
- vfdb2tsv.nf
- victors.nf
- writeCSV.nf
- bacannot.nf
- bacannot_dbs.nf
- parse_samples.nf
- .gitattributes
- .gitignore
- .gitpod.yml
- .readthedocs.yml
- .zenodo.json
- example_samplesheet.yaml
- LICENSE
- main.nf
- mkdocs.yml
- nextflow.config
- nextflow_schema.json
- README.md
# Installation Guide
1. Get the code
git clone https://github.com/fmalmeida/bacannot
Downloads the entire project code from GitHub to your computer.
cd bacannot
Moves into the project folder you just downloaded.
2. Official Install Script
Easy RecommendedPrerequisites
- Python 3 Python is required to use pip.
pip install nf-core
Installs the package published on PyPI directly โ no need to clone the source.
curl -s https://get.nextflow.io | bash
Downloads and runs the official install script in one line โ this handles the full setup automatically.
After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.
Pulled directly from this repo's README.
3. Docker
EasyPrerequisites
- Git Needed to download the project code from GitHub.
- Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
nextflow run fmalmeida/bacannot -profile docker --help
Type this command into your terminal and run it.
Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.
Pulled directly from this repo's README.
// repository documentation
Was this content helpful?
(0 ratings)
