Document snakemake commands with required cores argument #599
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
Adds the required `--cores 1` argument to all calls to snakemake in both scripts and documentation. This is the first step toward removing Snakemake as an augur dependency [1]. [1] #557
Codecov Report
@@ Coverage Diff @@
## master #599 +/- ##
=======================================
Coverage 26.58% 26.58%
=======================================
Files 36 36
Lines 5278 5278
Branches 1306 1306
=======================================
Hits 1403 1403
Misses 3825 3825
Partials 50 50 Continue to review full report at Codecov.
|
|
@huddlej Why |
|
@tsibley One core is a safer default for most environments (especially a shared environment like a rhino node on the Hutch cluster) and I prefer to have an explicit integer argument that hints to new users that there is a value they can change as they wish. |
|
@huddlej Makes sense, thanks for the rationale! (FWIW, I think rationale like that is a great thing to put in commit messages. :-) |
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.
Adds the required
--cores 1argument to all calls to snakemake in both scripts and documentation. This is the first step toward removing Snakemake as an augur dependency.