Skip to content

Improved Documentation
Compare
Choose a tag to compare
@aryarm aryarm released this 08 Jul 15:42
· 47 commits to master since this release
v0.2.1
8217916

This release updates README files across the repository in an effort to improve our documentation.

  1. The main README provides just enough information for those who want to run the pipeline on the example data.
  2. The config.yaml section of the config README instructs users on how to execute the pipeline on their own data.
  3. The rest of the config README and the rules README tells them how to run the "prepare" and "classify" subworkflows separately from the master pipeline. It also instructs users on how to reproduce our results.
  4. Add to that the callers README, and they should be able to try their own variant callers.
  5. And the comments within the config files provide everything anyone could possibly want to know.
Assets 3
Loading