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 pkgcheck to repository #4

Merged
merged 6 commits into from
Jun 28, 2024
Merged

Add pkgcheck to repository #4

merged 6 commits into from
Jun 28, 2024

Conversation

cforgaci
Copy link
Contributor

I also added pkgcheck which needs to be passed if we want to submit the package for review on rOpenSci, as indicated in the proposal.

@cforgaci cforgaci added the enhancement New feature or request label Jun 25, 2024
@cforgaci cforgaci requested a review from fnattino June 25, 2024 12:15
@cforgaci cforgaci self-assigned this Jun 25, 2024
@cforgaci cforgaci linked an issue Jun 25, 2024 that may be closed by this pull request
@cforgaci cforgaci marked this pull request as ready for review June 25, 2024 12:15
This is needed to pass the test coverage check of pkgcheck
Copy link
Contributor

@fnattino fnattino left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice! The repository is getting more and more complete. Two things that I think should be added as well are:

  • a CITATION.cff file (see e.g. here)
  • a GitHub action running a code linter, it is always nice to get static code analysis and check the code against code style (I see you mentioned this in the CONTRIBUTING file). Maybe lintr? I see that a GitHub action can be easily created with usethis.

I guess these could also be addressed in new PRs.

@cforgaci
Copy link
Contributor Author

I guess these could also be addressed in new PRs.

Yes, let's address these in separate PRs as they are not formally part of pkgcheck.

Copy link
Contributor

@fnattino fnattino left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The error it raises is linked to the fact that the package only contains a dummy file and no public functions, correct? In that case I think this can also be merged!

@cforgaci
Copy link
Contributor Author

The error it raises is linked to the fact that the package only contains a dummy file and no public functions, correct? In that case I think this can also be merged!

I am not sure, but in any case I would explore this error in the context of the (now) more complete main branch. I will merge.

@cforgaci cforgaci merged commit 664829c into main Jun 28, 2024
7 of 8 checks passed
@cforgaci cforgaci deleted the 3-pkgcheck-cf branch June 28, 2024 11:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Pass pkgcheck tests
2 participants