Documentation: CRAN compliance changes #61
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
martinctc
added a commit
that referenced
this pull request
Feb 5, 2021
This is directly committed to the main branch to test the experience on the GitHub site. This is part of a series of changes linked to #61.
Replace "#' ##" with "#' #"
Add more detail on usage
More informative for users on package version number
More detail is added to the working patterns function documentation, including an explication of the methodology, copyright headers, as well as general formatting.
+ General clean up of all functions on documentation consistency.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This branch implements some changes mostly to the documentation, for CRAN compliance purposes.
Changes
The changes made in this PR are:
Authors@Rfield inDESCRIPTION.validation_report(), including the constituent checking functions.Checks
roxygen2::roxygenise()has been run prior to merging to ensure that.RdandNAMESPACEfiles are up to date.Notes
This PR partially fixes the below issues. Many are blanket changes to a lot of the documentation in the package, and therefore would take a longer time to fully implement:
returnoptions are not consistently shown #31