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

Test package functionalities, document user experience issues #3

Open
pitkant opened this issue Jun 28, 2024 · 0 comments
Open

Test package functionalities, document user experience issues #3

pitkant opened this issue Jun 28, 2024 · 0 comments
Assignees
Labels
good first issue Good for newcomers

Comments

@pitkant
Copy link
Member

pitkant commented Jun 28, 2024

Test all functions in the package. Pay attention to the following details:

  • does function documentation give enough information and context? Should there be (more) examples? Is the return value documented? (see R Packages 2e Function documentation: https://r-pkgs.org/man.html)
  • Are all lines of code tested? Are there some lines that should not be tested, for example if they are related to some very rare condition (nocov)?
  • Should there be more vignettes / articles? What is missing?
  • Compared to other data retrieval packages, are there some features / function parameters etc. that would be useful?
  • Are there some performance bottlenecks? Does loading data into R consume lots of RAM, does downloading data take lots of time, would caching be useful...?

Take notes when going through the package functions. You can post them under this issue or keep them locally, we can go through them later

@pitkant pitkant added the good first issue Good for newcomers label Jun 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

3 participants