merenlab / anvio

An analysis and visualization platform for 'omics data
http://merenlab.org/software/anvio
GNU General Public License v3.0
423 stars 144 forks source link

[FEATURE REQUEST] Adding the `ecophylo` and `trnaseq` workflows to anvi'o docs, and more #1986

Open meren opened 1 year ago

meren commented 1 year ago

In addition to artifacts and programs, the anvi'o docs now supports workflows following the PR #1977.

Adding a new workflow is quite straightforward, and every file that needs to be edited to add a new workflow is demonstrated in https://github.com/merenlab/anvio/pull/1977/commits/379ba4351c4aa939f7485af0b765ccded0234ed1.

Since there is already so much documentation, I think it will be quite straightforward to add the ecophylo workflow by @mschecht and the trnaseq workflow by @semiller10 into this. So I propose their addition to this system :)


We also need to clean up a few things, which I will do, including,

mschecht commented 1 year ago

@meren thanks again for giving workflows a separate documentation infrastructure. I took a swing at this here: https://github.com/merenlab/anvio/tree/ecophylo-artifact-documentation

Should I remove the ecophylo artifact in this branch or would we keep both artifacts?

mschecht commented 1 year ago

@meren can we also have an artifacts_accepted option? I think it's important to document which artifacts are the input to workflows as well e.g. the contigs-worklow should accept a fasta and ecophylo-worflow would accept hmm-list

meren commented 1 year ago

@meren can we also have an artifacts_accepted option?

This is now done, @mschecht.

ivagljiva commented 11 months ago

@meren and/or @mschecht , is this workflow documentation all finished? Can we close this issue? :)

meren commented 11 months ago

Let's keep this open for a little longer :)

Thank you for going through all these issues, Iva!

mschecht commented 11 months ago

Thanks for the ping everyone - I'll run through my current documentation and prepare commits. I know the release timeline is tight.

mschecht commented 11 months ago

Ok I made some minor adjustments but did not push the commit. Let me know if/when it's ok to push :)

ivagljiva commented 11 months ago

Please feel free to push your commits @mschecht. It would be great if you could do it as soon as possible :)