Skip to content
This repository has been archived by the owner on Jan 27, 2020. It is now read-only.

Beginners usage docs [skip ci] #639

Merged
merged 9 commits into from
Sep 13, 2018
Merged

Beginners usage docs [skip ci] #639

merged 9 commits into from
Sep 13, 2018

Conversation

alneberg
Copy link
Member

@alneberg alneberg commented Sep 12, 2018

This is mainly a rewrite of the "USAGE.md" docs. It is now written to be a minimal but complete example run with both germline and somatic analysis. However, I think we should change it to be the best-practice commands later.

  • Docs now have complete recommended commands for a complete analysis.
  • The possible parameters are moved into a separate PARAMETERS.md.
  • The parameters are divided based on the workflow script they apply to.
  • The tsv documentation is renamed to INPUT.md which also includes the recommended directory structure when using the --sampleDir option.
  • Customised profile is removed as we don't really explain how that would be done and it's not really intended for a regular user.

PR checklist

  • PR is made against dev branch
  • This comment contains a description of changes (with reason)
  • Documentation in docs is updated
  • CHANGELOG.md is updated
  • README.md is updated

@maxulysse
Copy link
Member

@alneberg OK for you to merge that?

@maxulysse maxulysse self-requested a review September 13, 2018 07:41
Copy link
Member

@maxulysse maxulysse left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it's much clearer now!
Thanks for the help

@maxulysse maxulysse merged commit 398daa6 into SciLifeLab:dev Sep 13, 2018
jherrero referenced this pull request in UCL-BLIC/Sarek_v2.2.1 Apr 11, 2019
Beginners usage docs [skip ci]
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants