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

Draft of results section for scpca-nf #34

Merged
merged 8 commits into from
Feb 28, 2024

Conversation

allyhawkins
Copy link
Member

Closes #27
Stacked on #26

This PR adds the section for describing scpca-nf to the results. I mostly followed the outline, but I was struggling a bit with where to include information on why Nextflow is cool. I left both options in the file and indicated them with html comments. I think I like talking about it right up front when we actually mention that the workflow is nextflow-based, but I'm curious what others think.

Also, I think I caught all the places for references, but please let me know if I missed any!

- Each process in the workflow is run in a docker container, so users only need to install Nextflow and docker to be able to use this workflow.
- Nextflow also handles parallelizing processing based on your environment and will configure processing so that run time is minimal.
All data available on the portal was uniformly processed using `scpca-nf`, an open-source and efficient Nextflow[@url:https://www.nextflow.io/docs/latest/index.html] workflow for quantifying single-cell and single-nuclei RNA-seq data (github.com/alexslemonade/scpca-nf).
<!-- TO DO: Does description of Nextflow benefits go here or a separate paragraph at the end?-->
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If you do it this way, it will be consistent with what I added in #46, and it usually makes spellcheck angry, which is helpful because then you know you still have a TODO in there somewhere!

Suggested change
<!-- TO DO: Does description of Nextflow benefits go here or a separate paragraph at the end?-->
<!-- TODO: Does description of Nextflow benefits go here or a separate paragraph at the end?-->

@allyhawkins
Copy link
Member Author

@jaclyn-taroni I made edits here to address the comments you left in the TODO comments.

  • I added in a sentence to link to alsf-scpca with the full benchmarking analysis, but I'm 50/50 on if we want do that. I don't think it's entirely necessary, but helpful if people are interested in learning more about how we did the benchmarking.
  • On that same note, I included the links to both scpca-nf and alsf-scpca as actual links - should they be references instead?
  • I added a description about miQC when we first mention it.

Copy link
Member

@jaclyn-taroni jaclyn-taroni left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am returning some suggestions. Including the AnnData citation is the only must-have from this batch. No need for me to take another look 👍🏻

content/03.results.md Outdated Show resolved Hide resolved
content/03.results.md Outdated Show resolved Hide resolved
content/03.results.md Outdated Show resolved Hide resolved
content/03.results.md Outdated Show resolved Hide resolved
Base automatically changed from allyhawkins/draft-results-overview to main February 28, 2024 15:14
Copy link

Click the link below to download the manuscript build as a ZIP file.
This build is associated with commit 021cc64.

Manuscript build

Copy link

Click the link below to download the manuscript build as a ZIP file.
This build is associated with commit 5ae3aef.

Manuscript build

@allyhawkins allyhawkins merged commit 3fc669d into main Feb 28, 2024
1 check passed
@allyhawkins allyhawkins deleted the allyhawkins/draft-results-scpca-nf branch February 28, 2024 15:24
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

Successfully merging this pull request may close these issues.

Draft: Results - scpca-nf overview
2 participants