From bb6e257f35ecded7a374312a6bfe26b1e1cb54ef Mon Sep 17 00:00:00 2001 From: James McMahon Date: Wed, 28 Aug 2024 15:04:10 +0100 Subject: [PATCH 1/3] Update make_inheritance_checks.R --- R/make_inheritance_checks.R | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/R/make_inheritance_checks.R b/R/make_inheritance_checks.R index f89372c..9cd839e 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 make_inheritance_checks <- function(arguments, target_classes, ignore_null = TRUE) { From c4a54cb8f3bd0f8b2b42c99d71007a8224f9e8ef Mon Sep 17 00:00:00 2001 From: Moohan Date: Wed, 28 Aug 2024 14:05:26 +0000 Subject: [PATCH 2/3] Update documentation --- DESCRIPTION | 2 +- man/phsmethods.Rd | 34 ++++++++++++++++++++++++++++++++++ 2 files changed, 35 insertions(+), 1 deletion(-) diff --git a/DESCRIPTION b/DESCRIPTION index d8dbd33..be42799 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -56,5 +56,5 @@ Encoding: UTF-8 Language: en-GB LazyData: true Roxygen: list(markdown = TRUE) -RoxygenNote: 7.2.3 +RoxygenNote: 7.3.2 VignetteBuilder: knitr diff --git a/man/phsmethods.Rd b/man/phsmethods.Rd index 64143ac..762545f 100644 --- a/man/phsmethods.Rd +++ b/man/phsmethods.Rd @@ -2,6 +2,7 @@ % Please edit documentation in R/phsmethods.R \docType{package} \name{phsmethods} +\alias{phsmethods-package} \alias{phsmethods} \title{\code{phsmethods} package} \description{ @@ -11,3 +12,36 @@ Standard Methods for use in PHS. See the README on \href{https://github.com/Public-Health-Scotland/phsmethods#readme}{GitHub}. } +\seealso{ +Useful links: +\itemize{ + \item \url{https://github.com/Public-Health-Scotland/phsmethods} + \item \url{https://public-health-scotland.github.io/phsmethods/} + \item Report bugs at \url{https://github.com/Public-Health-Scotland/phsmethods/issues} +} + +} +\author{ +\strong{Maintainer}: Tina Fu \email{Yuyan.Fu2@phs.scot} + +Authors: +\itemize{ + \item David Caldwell \email{David.Caldwell@phs.scot} + \item Jack Hannah \email{jack.hannah2@phs.scot} + \item Ciara Gribben \email{Ciara.Gribben@phs.scot} + \item Chris Deans \email{Chris.Deans2@phs.scot} + \item Jaime Villacampa \email{Jaime.Villacampa@phs.scot} + \item Graeme Gowans \email{Graeme.Gowans@phs.scot} + \item James McMahon \email{James.McMahon@phs.scot} (\href{https://orcid.org/0000-0002-5380-2029}{ORCID}) + \item Nicolaos Christofidis \email{nicolaos.christofidis@phs.scot} +} + +Other contributors: +\itemize{ + \item Public Health Scotland \email{phs.datascience@phs.scot} [copyright holder] + \item Lucinda Lawrie \email{Lucinda.Lawrie@phs.scot} [reviewer] + \item Alice Byers [contributor] + \item Alan Yeung \email{Alan.Yeung@phs.scot} [contributor] +} + +} From 7a8de8034d2ef219fe3c171dc27b380353583fba Mon Sep 17 00:00:00 2001 From: James McMahon Date: Wed, 28 Aug 2024 15:32:31 +0100 Subject: [PATCH 3/3] Remove .Rd file --- R/make_inheritance_checks.R | 1 + man/make_inheritance_checks.Rd | 24 ------------------------ 2 files changed, 1 insertion(+), 24 deletions(-) delete mode 100644 man/make_inheritance_checks.Rd diff --git a/R/make_inheritance_checks.R b/R/make_inheritance_checks.R index 9cd839e..1212f94 100644 --- a/R/make_inheritance_checks.R +++ b/R/make_inheritance_checks.R @@ -7,6 +7,7 @@ #' @param ignore_null boolean. Indicates whether to ignore arguments with value #' NULL (TRUE) or to throw an exception (FALSE). Default = TRUE. #' @internal +#' @noRd make_inheritance_checks <- function(arguments, target_classes, ignore_null = TRUE) { diff --git a/man/make_inheritance_checks.Rd b/man/make_inheritance_checks.Rd deleted file mode 100644 index be8e295..0000000 --- a/man/make_inheritance_checks.Rd +++ /dev/null @@ -1,24 +0,0 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/make_inheritance_checks.R -\name{make_inheritance_checks} -\alias{make_inheritance_checks} -\title{Check that a set of arguments inherits from a set of classes -Throws an exception if one argument does not pass the checks. -Argument must have AT LEAST ONE of the specified classes to pass.} -\usage{ -make_inheritance_checks(arguments, target_classes, ignore_null = TRUE) -} -\arguments{ -\item{arguments}{a list object containing argument_name=argument pairs for -each argument. Argument names must be provided or else they will be ignored.} - -\item{target_classes}{character vector of the classes to check for.} - -\item{ignore_null}{boolean. Indicates whether to ignore arguments with value -NULL (TRUE) or to throw an exception (FALSE). Default = TRUE.} -} -\description{ -Check that a set of arguments inherits from a set of classes -Throws an exception if one argument does not pass the checks. -Argument must have AT LEAST ONE of the specified classes to pass. -}