-
Notifications
You must be signed in to change notification settings - Fork 2
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
Splitting up README.md into several documents, all found in the docs
folder
#152
Conversation
I probably should have merged this into another branch so that the tests didn't run, but I decided to just shut them of manually so that we don't waste minutes. |
docs/output.md
Outdated
### `results` | ||
|
||
#### `qc` | ||
- `total_reads_qc.tsv.gz`: Total number of reads processed at each stage of the preprocessing phase (`stage`) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Need to update this description.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Still reviewing, but here are some initial comments on what seem to me to be the most important files
docs/installation.md
Outdated
|
||
Clone this repo into a new directory as normal. | ||
|
||
#### 4. Run index/reference workflow |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should we have new users run the test suite? That would be a good way to check that the pipeline works in their hands. But maybe we can't be sure their launcher instance will have enough resources to actually run the test suite?
That actually brings up a different topic: we should probably provide some guidance on what size instance is needed to run the pipeline on Batch. @harmonbhasin do you already do this somewhere?
There wasn't documentation for run_validation workflow before, do we want to add this for this pull request? @willbradshaw |
@willbradshaw this is ready for you to look at! |
…orkflow into harmon_documentation
Remove stale param
…the new pipeline to output folder.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A couple minor comments to resolve, then we're good to go!
…ry/mgs-workflow into harmon_documentation
…some output syntax.
I'm not done as yet, however I'd like some feedback! I've added my notes on where I think each doc is below. Please suggest restructuring or removing documents if you don't think they're helpful.