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 list_distributions example to repo readme #245

Closed
nlinton opened this issue Feb 26, 2024 · 4 comments
Closed

Add list_distributions example to repo readme #245

nlinton opened this issue Feb 26, 2024 · 4 comments
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Milestone

Comments

@nlinton
Copy link

nlinton commented Feb 26, 2024

As a user, if I want to use the package I first need an accessible way to see if the disease I am working on has any entry, how many entries there are for that disease, etc. (I.e. see what my options are). It took some digging to find the list_distributions function that had what I was looking for. It would be great if you added the list_distributions example to the repo readme so it is easier for users to find.

@nlinton
Copy link
Author

nlinton commented Feb 26, 2024

It would also be immensely helpful for list_distributions to output pathogen as the second column.

@joshwlambert
Copy link
Member

@nlinton Thank you for your suggestions. I will work on improving the README and adding the pathogen column.

Also just to add, the list_distributions() function will likely be renamed to parameter_tbl() as the current name is a little misleading about the return type.

@joshwlambert joshwlambert added documentation Improvements or additions to documentation enhancement New feature or request labels Feb 29, 2024
@joshwlambert joshwlambert self-assigned this Feb 29, 2024
@nlinton
Copy link
Author

nlinton commented Mar 1, 2024

Sounds good, and thanks for the heads up!

@joshwlambert
Copy link
Member

@nlinton apologies for the slow response and getting these changes merged into the main branch. There is a pull request (#321) open now which include the changes you've requested and will be merged later today. The issue will close once the PR is merged.

If the changes are not exactly what you were after, or you'd like to make another request please feel free to reopen this issue or open a new issue.

Thanks for the input to improve the package!

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 enhancement New feature or request
Projects
Status: Done
Development

No branches or pull requests

2 participants