Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

meta MS - Yuri #17

Closed
Tracked by #4
ssarrafan opened this issue Oct 25, 2024 · 18 comments
Closed
Tracked by #4

meta MS - Yuri #17

ssarrafan opened this issue Oct 25, 2024 · 18 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@ssarrafan
Copy link
Contributor

ssarrafan commented Oct 25, 2024

Follow the template below for the index.rst file that is in the docs folder of the repo for your workflow:
Title of Workflow
(Image)
Workflow overview
Workflow availability
Requirements for Execution
Hardware requirements
Workflow dependencies
Software
Database(s)
Sample dataset(s)
Input
Output
Version history
Point of contact

If you have updated figures please put the editable components of the figures here as well as in the documentation
Please follow the following format for updating your documentation:

@ssarrafan
Copy link
Contributor Author

@corilo can you please update with a link to the doc draft and status
I'll move to one more sprint
FYI @aclum

@ssarrafan
Copy link
Contributor Author

@corilo what's the status of this? Is this in progress? Can you complete this documentation by Friday?

@ssarrafan
Copy link
Contributor Author

Need to close the sprint. @corilo hopefully this is almost done?
FYI @lamccue

@kaijli
Copy link
Contributor

kaijli commented Nov 19, 2024

added standardized workflow figure microbiomedata/metaMS#62

@kaijli
Copy link
Contributor

kaijli commented Nov 20, 2024

not sure where to put this, but enviroMS also has PR for figure update microbiomedata/enviroMS#10

@aclum
Copy link
Contributor

aclum commented Nov 22, 2024

cc @kheal

@ssarrafan
Copy link
Contributor Author

@corilo said Meta MS documentation is done/updated. I'm moving to review for @aclum to check.

@corilo
Copy link
Member

corilo commented Nov 26, 2024

Just added the Hardware Requirements that was missing for both, MetaMS and EnviroMS

@aclum
Copy link
Contributor

aclum commented Nov 27, 2024

@corilo can you update the order of the sections so it matches what is in the issue description please. Also please take a look at the PR @kaijli, that version has a slightly different image where the blue box isn't as cut off. Please either accept those changes or close the PR without merging. microbiomedata/enviroMS#10

@ssarrafan
Copy link
Contributor Author

Moving to next sprint to finish review and changes @corilo @aclum @kaijli

@corilo
Copy link
Member

corilo commented Dec 2, 2024

@corilo can you update the order of the sections so it matches what is in the issue description please. Also please take a look at the PR @kaijli, that version has a slightly different image where the blue box isn't as cut off. Please either accept those changes or close the PR without merging. microbiomedata/enviroMS#10

@aclum I have just added the new images and changed the order of the sections in the documentation for both enviroms and metams. Please let me know if these changes meet your requirements. Thanks.

@aclum
Copy link
Contributor

aclum commented Dec 4, 2024

Could you

  1. expand on the database information. A link to more information about the database and what database version is used (see https://github.com/microbiomedata/mg_annotation/blob/master/docs/index.rst as an example)
  2. based on recent discussions it would be great to include a few sentences about when to use each of the calibration files in the workflow dependencies section.

@ssarrafan
Copy link
Contributor Author

@corilo can this be closed/wrapped up this week please?
@aclum

@corilo
Copy link
Member

corilo commented Dec 12, 2024 via email

@ssarrafan
Copy link
Contributor Author

Moving to next sprint per @corilo comment above.

@corilo
Copy link
Member

corilo commented Dec 16, 2024

I added more information about the calibration files for the enviroMS workflow and a few sentences about the database used for GC-MS. However, we need an external link or documentation that we can share at this point. The transparency issue will be solved when the API for the Metabolomics Database is made available (https://www.emsl.pnnl.gov/project/60086), which is set to be this month. I'll update the documentation as soon as the API is live.

@ssarrafan
Copy link
Contributor Author

@corilo @aclum can this issue be closed now? Thanks for working on this.

@corilo
Copy link
Member

corilo commented Dec 19, 2024 via email

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Development

No branches or pull requests

4 participants