Prepare for CRAN release#8
Merged
Merged
Conversation
This reverts commit 3f98cf7.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
I have gone through and fixed as many potential CRAN submission gotchas as I can find. Initial CRAN submissions will be reviewed by a human. I used the following resources:
I tested the changes using:
devtools::check()devtools::check_win_devel()devtools::check_mac_release()There are still a few outstanding issues that should probably be opened in a separate issue:
tarball naming conventions: Two tarballs exist in the release page with nearly identical names:
statgen_0.3.0.tar.gzandstatgen-0.3.0.tar.gz. The first one is the R package. These should ideally but differentiated, but I ran into problems renaming the R package tarball because R CMD CHECK defaults to usingpackage_version.tar.gz.The .Rd documentation files and NAMESPACE file are currently manually maintained, which is okay for CRAN submission but the R ecosystem standard is to use roxygen2 tags in .R files with auto-generation via devtools::document(). The main drawback is that man/ and NAMESPACE require manual updates with code changes. Migrating to roxygen2 in the future would eliminate this problem.
Closes #7