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

docs: describe workflow rationale #126

Open
3 tasks
deliaBlue opened this issue Nov 30, 2023 · 0 comments · May be fixed by #135
Open
3 tasks

docs: describe workflow rationale #126

deliaBlue opened this issue Nov 30, 2023 · 0 comments · May be fixed by #135
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@deliaBlue
Copy link
Collaborator

The user should be able to decide if MIRFLOWZ is the correct tool for them to use by reading how it works in the documentation.

To achieve so extend the explanation in the main README.md to include details on:

  • how the counting is done
  • how the mapping and filtering are done
  • the output files the user will get with some examples

In addition, in the pipeline_documentation.md, include examples of the common and edge cases that highlight the workflow behavior.

@deliaBlue deliaBlue added the documentation Improvements or additions to documentation label Nov 30, 2023
@deliaBlue deliaBlue self-assigned this Dec 8, 2023
@deliaBlue deliaBlue linked a pull request Jan 31, 2024 that will close this issue
@deliaBlue deliaBlue linked a pull request Jan 31, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant