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

[Do not merge!] Pseudo PR for first release #28

Closed
wants to merge 498 commits into from
Closed

[Do not merge!] Pseudo PR for first release #28

wants to merge 498 commits into from

Conversation

mashehu
Copy link

@mashehu mashehu commented Aug 2, 2024

Do not merge! This is a PR of dev compared to first release for whole-pipeline reviewing purposes. Changes should be made to dev and this PR should not be merged into first-commit-for-pseudo-pr!

atrull314 and others added 30 commits September 5, 2023 11:29
…regardless of if the user chooses to trim files or not
atrull314 and others added 16 commits September 11, 2024 15:32
Co-authored-by: Lili Andersson-Li <64467552+LilyAnderssonLee@users.noreply.github.com>
Co-authored-by: Lili Andersson-Li <64467552+LilyAnderssonLee@users.noreply.github.com>
Co-authored-by: Lili Andersson-Li <64467552+LilyAnderssonLee@users.noreply.github.com>
Co-authored-by: Lili Andersson-Li <64467552+LilyAnderssonLee@users.noreply.github.com>
Co-authored-by: Lili Andersson-Li <64467552+LilyAnderssonLee@users.noreply.github.com>
Co-authored-by: Lili Andersson-Li <64467552+LilyAnderssonLee@users.noreply.github.com>
Co-authored-by: Lili Andersson-Li <64467552+LilyAnderssonLee@users.noreply.github.com>
Copy link
Author

@mashehu mashehu left a comment

Choose a reason for hiding this comment

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

just some smaller things, will approve the other PR.

@@ -6,3 +6,8 @@ results/
testing/
testing*
*.pyc
test.sh
params.yml
Copy link
Author

Choose a reason for hiding this comment

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

Why do you explicitly ignore params and the samplesheet file?

Copy link
Collaborator

Choose a reason for hiding this comment

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

During development, we often worked out of the github directory and would place the samplesheet and parameter files in there, so to remove the chance of an accidental commit of either one we went ahead and added them here.

Copy link
Author

Choose a reason for hiding this comment

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

very nice tube map. small nit-picky thins you can ignore:

  • can you please name it something like scnanoseq_tube_map, so we can pick automatically pick it up for some future nf-core things.
  • can you also provide an svg version, which makes it easier for collaborators to edit and extend the map
  • can you trie to center the "Alignment" and the "Barcode correction" nodes in the middle of their respective curves
  • In the legend, I would flip the symbol for File Output 180 degrees (so it ends in the horizontal bar, following the reading direction)
  • might be an optical illusion, but are the Count QC nodes correctly horizontally centered between the curves before and after them?

Copy link
Collaborator

Choose a reason for hiding this comment

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

I went ahead and tried to address all these with commit 86284fa. Let me know if you see any missing/ anything else

docs/output.md Outdated Show resolved Hide resolved
docs/usage.md Outdated
```

### Full samplesheet
`cell_count` refers to the expected number of cells for each sample, which can vary from sample to sample.
Copy link
Author

Choose a reason for hiding this comment

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

is that value relevant for a specific processing step?

Copy link
Collaborator

Choose a reason for hiding this comment

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

It is -- cell count is utilized by the BLAZE barcode caller as a guide to determine the 'correct' number of barcodes that need to be called

Copy link
Author

Choose a reason for hiding this comment

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

i would clarify that here (or point to the relevant section in the docs)

Copy link
Collaborator

@atrull314 atrull314 Oct 2, 2024

Choose a reason for hiding this comment

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

I combined this fix with the point below. We have a table describing the columns so I added the expanded description in there (commit 891b67d)

docs/usage.md Show resolved Hide resolved
blaze_whitelist = file("$baseDir/assets/whitelist/3M-february-2018.zip")
}
else{
blaze_whitelist = file("$baseDir/assets/whitelist/737K-august-2016.txt.zip")
Copy link
Author

Choose a reason for hiding this comment

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

shouldn't then be 10X_5v2 the default value for barcode_format?

Copy link
Collaborator

Choose a reason for hiding this comment

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

Yeah it does read like that, I think it may make more sense to turn the second else into an else if (params.barcode_format.equals("10X_5v2") for readability, since this param can only be one of those two values anyway so it makes it more clear

Copy link
Collaborator

Choose a reason for hiding this comment

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

Tried to address this with commit c082e20

workflows/scnanoseq.nf Show resolved Hide resolved
@atrull314
Copy link
Collaborator

Hi @mashehu,

I believe I managed to address all points, let me know if there's anything missing or if there's any other issues!

Thanks,
Austyn

@mashehu
Copy link
Author

mashehu commented Oct 3, 2024

All good now from my side! 👍🏻

@atrull314
Copy link
Collaborator

Awesome, thank you so much!

So as far as activating zenodo. Is that just a post in the pipeline-maintainers channel once we merge into the master branch or can that be done before the merge?

@mashehu
Copy link
Author

mashehu commented Oct 3, 2024

zenodo is already activated. so as soon as you make a release, you will get your DOI

@atrull314 atrull314 closed this Oct 7, 2024
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.

4 participants