Skip to content

Commit

Permalink
Merge pull request #96 from jolespin/devel
Browse files Browse the repository at this point in the history
v2.0.0
  • Loading branch information
jolespin authored May 17, 2024
2 parents bd1fddb + 1dde8e1 commit b67f0ed
Show file tree
Hide file tree
Showing 11 changed files with 7 additions and 283 deletions.
6 changes: 3 additions & 3 deletions FAQ.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
______________________
#### *VEBA* has so many modules and capabilities, how can I get a feel for how to use it for my dataset(s)?

Check out the [walkthroughs](https://github.com/jolespin/veba/tree/main/walkthroughs) where there are step-by-step workflows for different types of data.
Check out the [walkthroughs](https://github.com/jolespin/veba/tree/main/walkthroughs) where there are step-by-step workflows for different types of data. For a visual walkthrough of the modules, watch the [Getting started with VEBA](https://www.youtube.com/watch?v=pqrIffWNuug) YouTube video. There are several video tutorials on our [YouTube Channel @VEBA-Multiomics](https://www.youtube.com/@VEBA-Multiomics) covering topics such as how to get started, how to install/configure databases, custom installations/databases, Docker usage on local machines, and the end-to-end walkthrough in real-ish time.

<p align="right"><a href="#faq-top">^__^</a></p>

Expand All @@ -28,7 +28,7 @@ Since this is more advanced usage, you'll have to go through and comment out the
______________________


### How can I install just a single module and a subset of the database required for that module?
#### How can I install just a single module and a subset of the database required for that module?

This can be done easily with a custom installation. For example, let's say you want to only use the `annotate.py` module. You would go to the [module table](https://github.com/jolespin/veba/blob/main/bin/README.md) to see that `annotate.py` module uses the `VEBA-annotate_env` and the `Annotate` database. Then you would install the custom build as follows:

Expand Down Expand Up @@ -644,7 +644,7 @@ Are there any large contigs? What's the N50?

______________________

### How can I use Docker or Singularity to run VEBA?
#### How can I use Docker or Singularity to run VEBA?

Check out the [*VEBA* walkthroughs for Docker, Singularity, and AWS](https://github.com/jolespin/veba/tree/main/walkthroughs#containerization-and-aws).

Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
[issues-shield]: https://img.shields.io/github/issues/jolespin/veba.svg?style=for-the-badge
[issues-url]: https://github.com/jolespin/veba/issues

[![Schematic](images/graphical-abstract.png)](images/Schematic.pdf)
[![Schematic](images/graphical-abstract.png)](images/graphical-abstract.pdf)

### What is VEBA?
The *Viral Eukaryotic Bacterial Archaeal* (VEBA) is an open-source software suite developed with all domains of microorganisms as the primary objective (not post hoc adjustments) including prokaryotic, eukaryotic, and viral organisms. VEBA is an end-to-end metagenomics and bioprospecting software suite that can directly recover and analyze eukaryotic and viral genomes in addition to prokaryotic genomes with native support for candidate phyla radiation (CPR). VEBA implements a novel iterative binning procedure and an optional hybrid sample-specific/multi-sample framework that recovers more genomes than non-iterative methods. To optimize the microeukaryotic gene calling and taxonomic classifications, VEBA includes a consensus microeukaryotic database containing protists and fungi compiled from several existing databases. VEBA also provides a unique clustering-based dereplication strategy allowing for sample-specific genomes and proteins to be directly compared across non-overlapping biological samples. VEBA also automates biosynthetic gene cluster identification and novelty scores for bioprospecting.
Expand Down
Binary file modified images/Schematic.pdf
Binary file not shown.
Binary file modified images/Schematic.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion images/Schematic/Schematic_v1.1.x.gslides
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"":"WARNING! DO NOT EDIT THIS FILE! ANY CHANGES MADE WILL BE LOST!","doc_id":"1kgxUEfnlyF3h1ieYR2wABSSanKIEUFYrJBDDQUJbLJc","resource_key":"","email":"[email protected]"}
{"":"WARNING! DO NOT EDIT THIS FILE! ANY CHANGES MADE WILL BE LOST!","doc_id":"1dPtRoigCmvF6asvqCR3pJAJ-daAUF_tAoYPzXHQ1Edc","resource_key":"","email":"[email protected]"}
2 changes: 1 addition & 1 deletion images/Schematic/Schematic_v1.2.0.gslides
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"":"WARNING! DO NOT EDIT THIS FILE! ANY CHANGES MADE WILL BE LOST!","doc_id":"1wZhXu19GhIcY0E0YscQaCIK6MEPK4nllNFDAeHJtsHw","resource_key":"","email":"[email protected]"}
{"":"WARNING! DO NOT EDIT THIS FILE! ANY CHANGES MADE WILL BE LOST!","doc_id":"1MYo9n8YFHYN9UE-jtBSSmVgztkRfnoCMdOCPdHlOehw","resource_key":"","email":"[email protected]"}
2 changes: 1 addition & 1 deletion images/Schematic/Schematic_v2.0.0.gslides
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"":"WARNING! DO NOT EDIT THIS FILE! ANY CHANGES MADE WILL BE LOST!","doc_id":"1F97THCJYgPImOFqPAeb56k8sGvpGHPUHwUKFfypv8ms","resource_key":"","email":"[email protected]"}
{"":"WARNING! DO NOT EDIT THIS FILE! ANY CHANGES MADE WILL BE LOST!","doc_id":"13EHm4cj_U80pumbc2NIeiDpvlkDmh-3mk-iUP6cBRgU","resource_key":"","email":"[email protected]"}
44 changes: 0 additions & 44 deletions images/devel/Modules/assembly.md

This file was deleted.

65 changes: 0 additions & 65 deletions images/devel/Modules/binning-prokaryotic.md

This file was deleted.

114 changes: 0 additions & 114 deletions images/devel/Modules/mermaid_test.md

This file was deleted.

53 changes: 0 additions & 53 deletions images/devel/Modules/preprocess.md

This file was deleted.

0 comments on commit b67f0ed

Please sign in to comment.