check_best_practices: Check if a package complies with the skeleton IQSS Best...

In IQSS/IQSSdevtools: Initialize and Compile Packages Complying with IQSS Best Practices for Software Development and Sustainability

Description

Check if a package complies with the skeleton IQSS Best Practices for Statistical Software Development

Usage

check_best_practices(path = ".", save_results = TRUE,
  report_results = TRUE, list_results = FALSE, check_urls = TRUE,
  base_url, run_cran_check = TRUE, calculate_coverage = TRUE)

Arguments

path	character string of the package path.
save_results	logical whether or not to save the results of the check in the package directory in a YAML file called .iqss.bestpractices.yml.
report_results	logical whether or not to report the results to the console.
list_results	logical whether or not to return the results as a list.
check_urls	logical whether or not to check that URLs point to sites that exist.
base_url	a character string or vector of character strings for a domain or domains for which relative links are subdomains. Used to resolve relative URL paths in documentation.
run_cran_check	logical whether or not to run CRAN check.
calculate_coverage	logical whether or not to calculate test coverage.

Details

Checks whether an R package is compliant with the minimal standards set out in the IQSS Best Practices for Software Development and Sustainability.

Value

By default the function retuns a summary of the best practices check to the console and a YAML formatted file called .iqss_reportcard.yml to the package directory.It also updates the .Rbuildignore file so that it will not conflict with the package build. A list can also be returned with list_results = TRUE.

See Also

The IQSS Report Card Spec can be found at: https://github.com/IQSS/social_science_software_toolkit/blob/master/report_card/iqss_report_card_spec.md

Examples

## Not run: 
check_best_practices()

## End(Not run)

IQSS/IQSSdevtools documentation built on May 8, 2019, 10:54 a.m.