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

misleading documentation for report parameters #3

Closed
3 tasks done
fruce-ki opened this issue Sep 1, 2021 · 1 comment
Closed
3 tasks done

misleading documentation for report parameters #3

fruce-ki opened this issue Sep 1, 2021 · 1 comment
Assignees
Labels
bug Something isn't working documentation Improvements or additions to documentation
Milestone

Comments

@fruce-ki
Copy link
Collaborator

fruce-ki commented Sep 1, 2021

-r is documented as defaulting to 1. As of version 0.8.* this is no longer the case. The parameter can be omitted completely.

Omiting the parameter has new behaviour, compared to setting it to 1:

  • Setting it to 1 (or other integer(s)) will designate the corresponding samples as reference samples. Barcodes will be named by order of decreasing abundance in the reference, and any barcodes seen in bottlenecked samples that are not seen in the reference will be removed from all the samples.

  • Omitting it allows processing of batches that do not have a reference sample. Barcodes will be named based on their abundances in the first available sample, but no filtering will take place based on their presence/absence in that sample.

  • Update report readme

  • Update workflow readme

  • Update workflow

@fruce-ki fruce-ki added this to the 0.8.2 milestone Sep 1, 2021
@fruce-ki fruce-ki self-assigned this Sep 1, 2021
@fruce-ki fruce-ki added bug Something isn't working documentation Improvements or additions to documentation labels Sep 1, 2021
fruce-ki added a commit that referenced this issue Sep 1, 2021
fruce-ki added a commit that referenced this issue Sep 1, 2021
fruce-ki added a commit that referenced this issue Sep 1, 2021
This reverts commit 44c3fbe.
fruce-ki added a commit that referenced this issue Sep 1, 2021
This reverts commit 857dd56.
fruce-ki added a commit that referenced this issue Sep 1, 2021
fruce-ki added a commit that referenced this issue Sep 1, 2021
@fruce-ki fruce-ki closed this as completed Sep 1, 2021
@fruce-ki fruce-ki reopened this Sep 1, 2021
@fruce-ki
Copy link
Collaborator Author

fruce-ki commented Sep 1, 2021

The workflow script needs to be updated too. It does not accommodate thee omission of the reference parameter.

fruce-ki added a commit that referenced this issue May 27, 2022
fruce-ki added a commit that referenced this issue May 27, 2022
@fruce-ki fruce-ki closed this as completed Jun 2, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant