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

Proposal: re-order tutorials for a more streamlined learning path #293

Open
fasterius opened this issue Dec 3, 2024 · 1 comment
Open

Comments

@fasterius
Copy link
Collaborator

The way we currently present reproducibility is with three things: code, environment and workflow. The way we present these through the tools is, however, a little fragmented. We go from code (Git) to environment (Conda) to workflow (Snakemake/Nextflow) to code and/or workflow depending on how you view it (Quarto/Jupyter) to environment (Docker/Apptainer). There was some discussions during the course to re-order this to be more consistent/linear in terms of what thing we are working with. I generally thing this is a good idea, depending on if we can get a better order going and if that order works with the logistics of making a five-day schedule work without too many breakups between days for each session.

Going by which tutorials mention the others, the simplest solution schedule-wise might actually be just switch the container day (fourth day) with the workflow day (second day). Most other things are mentioned by the workflow managers (as they utilise e.g. containers and Conda environments). The Jupyter tutorial mentions containers in its extra material as well. The container tutorial mentions Jupyter twice (both linking to Jupyter base images, which could probably be moved or removed) and Quarto once (as having used Quarto to write the supplementary material for the case study). The biggest problem here would be the mentions of Snakemake and Nextflow throughout the container tutorial. If we want to do this change we would have to re-write sections of the container tutorial, but the question is if we want to do this regardless, see #289.

@mahesh-panchal
Copy link
Contributor

I think it would be good if it went
Data management -> Git -> Conda/Pixi -> Containers -> Notebooks -> Workflows

The container part could then hopefully then be reduced to only describe what containers are, how to find them (Biocontainers/Seqera Containers), how run/reuse them ( in bash ), and for the advanced people (i.e extra material), how to write and build a Dockerfile.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants