Update documentation #9
Merged
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
Collaborator
mkatsanto
commented
Oct 6, 2022
mkatsanto
commented
- minimal specs
- change order of sections
- estimated running time of local test.
…stimated running time of local test.
mzavolan
reviewed
Oct 7, 2022
|
|
||
| In order to run RCRUNCH, please fill in the organism related data and the experiment-dependent parameters for the different samples in the file `config.yaml`. | ||
|
|
||
| > ✨ For your convenience an empty [config.yaml](config.yaml) file is available to fill in. | ||
|
|
||
|
|
||
| ### 5b. Dry run and DAG generation (optional) | ||
| ### 6b. Dry run and DAG generation (optional) |
There was a problem hiding this comment.
Explain what "dry run" is, e.g. "To check whether the pipeline can run and all of the dependencies are satisfied, without actually executing the commands, you can do a 'dry run' with the following command:
This command will generate a graph (directed acyclic graph, DAG) that shows you how the data would flow through the pipeline.
mzavolan
reviewed
Oct 7, 2022
README.md
Outdated
| @@ -142,20 +168,5 @@ nohup bash run_local_singularity.sh & | |||
|
|
|||
| > ✨ Note: You can use any one of the: `nohup`, `screen` or `tmux`. | |||
|
|
|||
| ## Testing | |||
| To ensure that the version is working properly you can test it by: | |||
There was a problem hiding this comment.
To ensure that the code is working... version would raise question as to what the version is and how it relates to others
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.