Skip to content
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

Add input and output documentation #17

Open
grst opened this issue Nov 18, 2021 · 0 comments
Open

Add input and output documentation #17

grst opened this issue Nov 18, 2021 · 0 comments

Comments

@grst
Copy link
Member

grst commented Nov 18, 2021

There are two TODO statements in the README.md:

  • Update input documentation
  • Update output documentation

The input documentation should be as clear that any Bioinformatician who has never worked on this project before is able to run the pipeline.

The output documentation (together with the report (#16) should be enough for wetlab-scientists to understand the analysis without you explaining additional details.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant