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

Lipidomics workflow documentation #74

Open
Tracked by #4
ssarrafan opened this issue Dec 11, 2024 · 6 comments
Open
Tracked by #4

Lipidomics workflow documentation #74

ssarrafan opened this issue Dec 11, 2024 · 6 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@ssarrafan
Copy link
Contributor

ssarrafan commented Dec 11, 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

@ssarrafan ssarrafan converted this from a draft issue Dec 11, 2024
@ssarrafan
Copy link
Contributor Author

@aclum is there any other section you think we'll need for the lipids workflow?

@ssarrafan ssarrafan added the documentation Improvements or additions to documentation label Dec 11, 2024
@kheal
Copy link

kheal commented Dec 11, 2024

I'm planning on adding the lipidomics workflow to the MetaMS repo, should I make a separate index.rst or add to the existing one which also has the Metabolomics workflow?

@kheal
Copy link

kheal commented Dec 11, 2024

This is a repeat of microbiomedata/metaMS#31

@aclum
Copy link
Contributor

aclum commented Dec 11, 2024

I'd recommend a separate index.rst file so we can use the chapter formatting
https://github.com/microbiomedata/docs/blob/main/src/workflow_docs/index.rst

@kheal
Copy link

kheal commented Dec 12, 2024

@aclum @ssarrafan

I plan on merging the documentation into the main branch of MetaMS once we've worked out our blockers. In the meantime, can you let me know if I'm missing anything in this .rst file? I'm not going to open a PR because this is just a mirrored branch (we do development on gitlab), but I'll make any changes you'd like to see on this branch so you can see the work in progress.

https://github.com/microbiomedata/metaMS/blob/lipid_dev/docs/lcms_lipidomics/index.rst

@ssarrafan
Copy link
Contributor Author

This looks great @kheal. @aclum can this be closed?

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

3 participants