Document that skip_collapse turns on paired-end alignment.
#665
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Following issue nf-core#652, I would like to propose to explicitly mention that `skip_collapse` turns on paired-end alignment, so that a keyword search in the _parameters_ page of the documentation will reveal the information.
apeltzer
requested changes
Jan 15, 2021
jfy133
requested changes
Jan 25, 2021
There was a problem hiding this comment.
@charles-plessy thanks for the PR (and sorry for my slow follow up)! I've made a commit suggestion and also expanded the PR so the information is also described in the 'detailed' help information (not just the short one). Please commit the suggestions if you're happy with them.
As of course, as @apeltzer says, please update the changelog. You're also welcome to add yourself ot the 'Additional Contributors' of the README if you wish, just follow the format as for those already there.
|
@apeltzer I updated the changelog (to get this in), if your'e happy, please approve and merge. |
charles-plessy
commented
Jan 26, 2021
apeltzer
reviewed
Jan 26, 2021
jfy133
approved these changes
Jan 28, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Following issue #652, I would like to propose to explicitly mention that
skip_collapseturns on paired-end alignment, so that a keyword search in the parameters page of the documentation will reveal the information.(PS: sorry for the newline change at the end of the patch; it seems that GitHub added it automatically).