NEWS.md
update_citation() on a DESCRIPTION.check_spelling() handles Roxygen2 tags @aliases, @importMethodsFrom, @include, @keywords, @method, @name, @slot
check_spelling() ignores numbers.check_lintr() returns an error about global variables in a function and you did require() the package.organisation() class to hold the requirements of the organisation. For the time being this is hard-coded to the Research Institute for Nature and Forest (INBO).organisation(). The membership of an author is determined by their e-mail or their affiliation. This is checked when creating or using author information and when updating citation information.read_checklist() looks for checklist.yml in parent folders when it can’t find it in the provided path.validate_orcid() checks the format and the checksum of the ORCID.vignette("folder", package = "checklist").citation_meta() gains support for bookdown reports.bookdown_zenodo() which first extracts the citation metadata from the yaml header. Then it cleans the output folder and renders the required output formats. Finally it uploads the rendered files to a draft deposit on Zenodo.setup_project() and create_project() provides support for renv.MIT license was chosencreate_project() and setup_project() which interactively guides the user through the set-up.vignette("getting_started_project", package = "checklist").GITHUB_TOKEN. The user only needs to set the CODECOV_TOKEN in case of a package."MIT" license.roxygen2 tags in .R files..Rd files generated by roxygen2.check_cran() ignores Days since last update note.check_documentation() yields a warning when it find documented but unexported function. Use the @noRD tag in case you still want to document the function without exporting it.check_news().check_source() is now deprecated. Use check_project() instead.DESCRIPTION (for a package) or README.md (for a project) to extract citation information into a citation_meta object. Then export this object into the different citation files.DESCRIPTION and README.md to accommodate all citation information. DESCRIPTION gains checklist specific settings like Config/checklist/communities and Config/checklist/keywords.create_package() or create_project().check_folder().check_license() allows "MIT" license in addition to "GPLv3" for packagesvignette("spelling", package = "checklist") for more details.checklist class stores the required checks.setup_project() to set-up checklist on an existing project. This function allows the user to choose which checks to be required.check_project() to run the required checks of a project..zenodo.json when only one keyword is present.check_description() enforces a Language field with a valid [ISO 639-3 code] (https://en.wikipedia.org/wiki/Wikipedia:WikiProject_Languages/List_of_ISO_639-3_language_codes_(2019)).create_package() gains a required language argument. This adds the required Language field to the DESCRIPTION.checklist objects gain an update_keywords method. This is currently only relevant for packages. Usage: check your package with x <- check_package(). Add keywords with x$update_keywords(c("keyword 1", "keyword 2"). The method adds the keyword "R package" automatically. Store the keywords with write_checklist(x). Run update_citation() to update the citation files with the keywords. Use x$get_keywords() to retrieve the current keywords..rda files in the inst folder of a package.NEWS.md.prepare_ghpages().check_cran() ignores the insufficient package version when checking the main branch. This required when checking an R package when the current version equals the latest version on CRAN.vignette("zenodo") on how to set up the integration with Zenodo and ORCID
check_environment() makes sure that the required repository secrets are set. check_package() performs this check when it runs in a GitHub Action. A missing repository secret results in an error. It points to vignette("getting_started") which indicates how to solve it.write_zenodo_json() which produced a .zenodo.json which failed to parse on https://zenodo.org.write_zenodo_json() and write_citation_cff() return the checklist object and pass it to update_citation().lintr.check_description() when checking for changes in version number.update_package() escapes double quotes in the abstract of inst/CITATION.lintr
check_source() handles projects with renv on GitHub Actions.CITATION need to be commit. (#64)create_package() can use maintainer information stored in the options. See usethis::use_description() on how to set the option.write_zenodo_json() and write_citation_cff().create_package() replaces package name place holder with actual package name in _pkgdown.yml.update_citation() creates or updates a default citation in inst/CITATION.check_description() returns a warning rather than an error. This implies that you can motivate to ignore it via write_checklist(). (#33).Rd files when running check_filename(). (#59)check_filename() allows R/sysdata.rda. (#62)new_branch() function to start a new branch from the most recent version of the main branch. This function will run clean_git() before creating the new branch.check_package() runs the pkgdown::build_site() by default in interactive sessions. The function gains a pkgdown argument to turn of this behaviour.check_filename() handles git repositories without commits.check_filename() ignores Rd files. They have use a different naming convention when generated by roxygen2.clean_git() yields cleaner warnings.create_hexsticker() will create the target directory when it doesn’t exist.check_filename() ignores docker-compose files.renv and packrat folders from check_lintr().codemetar from GitHub because is it not available from CRAN.devtools from CRAN as the relevant version in available on CRAN.codemetar from GitHub results in a warning.Dockerfile. This triggers an error when a dependency is not listed in the Dockerfile.pkgdown ensures that the reference page lists all exported functions.pkgdown cascading style sheet.clean_git().clean_git() to bring a local git repo up-to-date.
create_hexsticker() yields an svg file instead of png. The user can optionally specify an svg icon file to add to the hexagonal sticker.master. GitHub is gradually renaming the default branch of our own repositories from master to main. Therefore checklist now allows both a main or master branch as default. In case both are present, checklist uses main. Using only a master branch yields a note. Hence you must either which to a main branch or allow the note with write_checklist() (#44).check_description().v. We use a GitHub Action to create the release instead of an R function.setup_source() to setup projects with only source files.create_hexsticker().check_filename() rules
data-raw foldercsl files must follow the rules for graphics filescreate_package() adds
DESCRIPTION
pkgdown.setup_package() updates .Rbuildignore and basic setup for pkgdown.set_tag().check_description() now checks authors (#7).
setup_package() adds the required files for a pkgdown website (#21).codemeta.json file. It requires constant updating as it contains a package file size.check_documentation() allows NEWS.md to have level 2 headings (##) and single line subitems (*). It doesn’t count URLs when determining the line of a line. This allows lines to be longer than 80 characters due to long URLs.check_filename() is more liberal.
-package.Rd.json or yml files starting with a dot and followed by letters.cran-comment.md and WORDLIST.man-roxygen as folder name._) as separator for non-graphics files.-) as separator for graphics files.write_checklist().codemeta.json as written by codemetar::write_codemeta. Suggestions by codemetar to improve the package become checklist notes.set_tag() fails when in a detached HEAD state.set_tag() creates a release when a tag is created on GitHub.check_cran() ignores system time check when world clock API is not available.check_license() verifies the license information of a package. This check is included via check_description() in check_package().set_tag() skips if the tag already exists.create_package() sets a code of conduct and contributing guidelines.create_package() sets LICENSE.md.pkgdown::build_site() during the check_pkg GitHub action.pkgdown website to a gp-pages branch when pushing to master during the check_pkg GitHub action.validate_email() to check for valid email addresses.orcid2person() which converts a valid ORCID into a person object.create_package() which prepare an RStudio project with an empty package.NEWS.md file to track changes to the package.README.Rmd file with installation instructions.checklist_template() into write_checklist().check_description().check_documentation().check_filename().check_source().check_lintr() also works on source code repositories.inbo/check_package.checklist R6 class.check_cran().check_lintr().check_package().read_checklist().checklist_template().