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.

Sign up for GitHub

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

Jump to bottom

Add information on inputs/outputs of the analysis to the Guide section of the README. #2

Open
whimsial opened this issue Feb 26, 2024 · 0 comments
Open

Add information on inputs/outputs of the analysis to the Guide section of the README. #2

whimsial opened this issue Feb 26, 2024 · 0 comments
Assignees
@whimsial
Labels
documentation Improvements or additions to documentation

Comments

@whimsial
Copy link
Member

Guide section of the README should be expanded with a minimal information of what data is to be supplied by the user to run a basic analysis and a quick outline of the analysis output. This will supplement the full guide on the package website.
@whimsial whimsial added the documentation Improvements or additions to documentation label Feb 26, 2024
@whimsial whimsial self-assigned this Feb 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@whimsial whimsial

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@whimsial