diff --git a/DESCRIPTION b/DESCRIPTION index 67731ce4..8130a9b3 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -3,7 +3,7 @@ Type: Package Title: Risk Metrics to Evaluating R Packages Description: Facilities for assessing R packages against a number of metrics to help quantify their robustness. -Version: 0.2.4 +Version: 0.2.4.9000 Authors@R: c( person("R Validation Hub", role = c("aut"), email = "psi.aims.r.validation@gmail.com"), person("Doug", "Kelkhoff", role = c("aut"), email = "doug.kelkhoff@gmail.com"), diff --git a/R/pkg_ref_class.R b/R/pkg_ref_class.R index d2522f13..20f17f98 100644 --- a/R/pkg_ref_class.R +++ b/R/pkg_ref_class.R @@ -292,7 +292,7 @@ as_pkg_ref.character <- function(x, repos = getOption("repos", "https://cran.rst #' #' @param x Package name or path to package #' @param source type of source passed in `pkg_ref` -#' @return one of c('pkg_install', 'pkg_install', 'pkg_cran_remote', +#' @return one of c('pkg_source', 'pkg_install', 'pkg_cran_remote', #' 'pkg_bioc_remote', 'pkg_missing') #' @keywords internal determine_pkg_source <- function(x, source, repos) { diff --git a/man/determine_pkg_source.Rd b/man/determine_pkg_source.Rd index 3f561007..1183ccd8 100644 --- a/man/determine_pkg_source.Rd +++ b/man/determine_pkg_source.Rd @@ -12,7 +12,7 @@ determine_pkg_source(x, source, repos) \item{source}{type of source passed in `pkg_ref`} } \value{ -one of c('pkg_install', 'pkg_install', 'pkg_cran_remote', +one of c('pkg_source', 'pkg_install', 'pkg_cran_remote', 'pkg_bioc_remote', 'pkg_missing') } \description{ diff --git a/man/pkg_assess.Rd b/man/pkg_assess.Rd index fd7c810b..a5b7733c 100644 --- a/man/pkg_assess.Rd +++ b/man/pkg_assess.Rd @@ -43,25 +43,25 @@ assessment applied. \section{Assessment function catalog}{ \describe{ +\item{\code{\link{assess_last_30_bugs_status}}}{vector indicating whether BugReports status is closed} \item{\code{\link{assess_covr_coverage}}}{Package unit test coverage} -\item{\code{\link{assess_has_news}}}{number of discovered NEWS files} -\item{\code{\link{assess_remote_checks}}}{Number of OS flavors that passed/warned/errored on R CMD check} -\item{\code{\link{assess_news_current}}}{NEWS file contains entry for current version number} +\item{\code{\link{assess_size_codebase}}}{number of lines of code base} +\item{\code{\link{assess_export_help}}}{exported objects have documentation} \item{\code{\link{assess_r_cmd_check}}}{Package check results} +\item{\code{\link{assess_dependencies}}}{Package dependency footprint} +\item{\code{\link{assess_reverse_dependencies}}}{List of reverse dependencies a package has} +\item{\code{\link{assess_license}}}{software is released with an acceptable license} +\item{\code{\link{assess_has_maintainer}}}{a vector of associated maintainers} +\item{\code{\link{assess_remote_checks}}}{Number of OS flavors that passed/warned/errored on R CMD check} \item{\code{\link{assess_exported_namespace}}}{Objects exported by package} -\item{\code{\link{assess_has_vignettes}}}{number of discovered vignettes files} -\item{\code{\link{assess_export_help}}}{exported objects have documentation} \item{\code{\link{assess_has_website}}}{a vector of associated website urls} -\item{\code{\link{assess_has_maintainer}}}{a vector of associated maintainers} -\item{\code{\link{assess_last_30_bugs_status}}}{vector indicating whether BugReports status is closed} -\item{\code{\link{assess_size_codebase}}}{number of lines of code base} -\item{\code{\link{assess_has_source_control}}}{a vector of associated source control urls} -\item{\code{\link{assess_has_bug_reports_url}}}{presence of a bug reports url in repository} \item{\code{\link{assess_downloads_1yr}}}{number of downloads in the past year} -\item{\code{\link{assess_reverse_dependencies}}}{List of reverse dependencies a package has} +\item{\code{\link{assess_has_news}}}{number of discovered NEWS files} +\item{\code{\link{assess_has_vignettes}}}{number of discovered vignettes files} \item{\code{\link{assess_has_examples}}}{proportion of discovered function files with examples} -\item{\code{\link{assess_dependencies}}}{Package dependency footprint} -\item{\code{\link{assess_license}}}{software is released with an acceptable license} +\item{\code{\link{assess_has_source_control}}}{a vector of associated source control urls} +\item{\code{\link{assess_has_bug_reports_url}}}{presence of a bug reports url in repository} +\item{\code{\link{assess_news_current}}}{NEWS file contains entry for current version number} } }