diff --git a/R/make_inheritance_checks.R b/R/make_inheritance_checks.R index 1212f94..92b6255 100644 --- a/R/make_inheritance_checks.R +++ b/R/make_inheritance_checks.R @@ -6,7 +6,7 @@ #' @param target_classes character vector of the classes to check for. #' @param ignore_null boolean. Indicates whether to ignore arguments with value #' NULL (TRUE) or to throw an exception (FALSE). Default = TRUE. -#' @internal +#' @keywords internal #' @noRd make_inheritance_checks <- function(arguments, target_classes, diff --git a/R/phsmethods-package.R b/R/phsmethods-package.R new file mode 100644 index 0000000..e896a15 --- /dev/null +++ b/R/phsmethods-package.R @@ -0,0 +1,11 @@ +#' @importFrom magrittr %>% +#' @importFrom magrittr %<>% +#' @importFrom rlang .data +#' @importFrom tibble tibble +#' @importFrom lifecycle deprecated +#' @keywords internal +"_PACKAGE" + +## usethis namespace: start +## usethis namespace: end +NULL diff --git a/R/phsmethods.R b/R/phsmethods.R deleted file mode 100644 index 8197566..0000000 --- a/R/phsmethods.R +++ /dev/null @@ -1,20 +0,0 @@ -#' `phsmethods` package -#' -#' Standard Methods for use in PHS. -#' -#' See the README on -#' [GitHub](https://github.com/Public-Health-Scotland/phsmethods#readme). -#' -#' @docType package -#' @name phsmethods -#' @importFrom magrittr %>% -#' @importFrom magrittr %<>% -#' @importFrom rlang .data -#' @importFrom tibble tibble -#' @importFrom lifecycle deprecated -NULL - -# Stops notes from appearing in R CMD check because of undefined global -# variable '.' and allows area_lookup dataset to be used inside match_area -# function -if (getRversion() >= "2.15.1") utils::globalVariables(c(".", "area_lookup")) diff --git a/man/phsmethods.Rd b/man/phsmethods-package.Rd similarity index 68% rename from man/phsmethods.Rd rename to man/phsmethods-package.Rd index 762545f..e4a01e7 100644 --- a/man/phsmethods.Rd +++ b/man/phsmethods-package.Rd @@ -1,16 +1,12 @@ % Generated by roxygen2: do not edit by hand -% Please edit documentation in R/phsmethods.R +% Please edit documentation in R/phsmethods-package.R \docType{package} -\name{phsmethods} -\alias{phsmethods-package} +\name{phsmethods-package} \alias{phsmethods} -\title{\code{phsmethods} package} +\alias{phsmethods-package} +\title{phsmethods: Standard Methods for Use in Public Health Scotland} \description{ -Standard Methods for use in PHS. -} -\details{ -See the README on -\href{https://github.com/Public-Health-Scotland/phsmethods#readme}{GitHub}. +A collection of methods for commonly undertaken analytical tasks, primarily developed for Public Health Scotland (PHS) analysts, but the package is also generally useful to others working in the healthcare space, particularly since it has functions for working with Community Health Index (CHI) numbers. The package can help to make data manipulation and analysis more efficient and reproducible. } \seealso{ Useful links: @@ -45,3 +41,4 @@ Other contributors: } } +\keyword{internal}