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

add to docs "prerequisites" in terms of skills #32

Open
2 tasks
Tracked by #35
sreichl opened this issue Oct 2, 2024 · 0 comments
Open
2 tasks
Tracked by #35

add to docs "prerequisites" in terms of skills #32

sreichl opened this issue Oct 2, 2024 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@sreichl
Copy link
Collaborator

sreichl commented Oct 2, 2024

@burtonjake: It would be good to think about what people need to learn in order to use MrBiomics effectively. For example they would need to already know how snakemake works, the way the job graph is generated. And then whether there is any way we can make this easier/reduce the barriers to using MrBiomoics.

  • clearly defined at the top of the MrBiomics repo README
  • succinctly at the top of every module repo README w/ a link to resources

Specify target audience and their required skill set.

  • Snakemake
  • Github
  • Command line in linux/unix
  • Familiar with file formats YAML, CSV, ...
  • Read up on module specific methods to set parameters and interpret results

Target audience and Requirements/ Target audience profile

  • Modules
    • Snakemake beginners/users
    • Job scheduler of system eg HPC or Cloud provide
  • Projects and Recipes
    • Snakemake advanced/developers
@sreichl sreichl self-assigned this Oct 2, 2024
@sreichl sreichl added the documentation Improvements or additions to documentation label Oct 2, 2024
@sreichl sreichl mentioned this issue Nov 13, 2024
23 tasks
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
None yet
Development

No branches or pull requests

1 participant