From 50ddae1dcdc24a7962d5fc574355e8eee6cab1ba Mon Sep 17 00:00:00 2001 From: "B.Anderson" <ba1e12@srv02405.soton.ac.uk> Date: Sun, 17 May 2020 23:44:05 +0100 Subject: [PATCH] updated functions with @import & @family where relevant; re-built --- NAMESPACE | 1 + R/loadLibraries.R | 1 + R/setup.R | 1 + R/tidyNum.R | 1 + man/loadLibraries.Rd | 6 ++++++ man/setup.Rd | 5 +++++ man/tidyNum.Rd | 6 ++++++ 7 files changed, 21 insertions(+) diff --git a/NAMESPACE b/NAMESPACE index aed6f16..3a060eb 100644 --- a/NAMESPACE +++ b/NAMESPACE @@ -3,4 +3,5 @@ export(loadLibraries) export(setup) export(tidyNum) +import(here) importFrom(utils,install.packages) diff --git a/R/loadLibraries.R b/R/loadLibraries.R index d523862..9dc036a 100644 --- a/R/loadLibraries.R +++ b/R/loadLibraries.R @@ -17,6 +17,7 @@ #' @author Luke Blunden, \email{lsb@@soton.ac.uk} (original) #' @author Michael Harper \email{m.harper@@soton.ac.uk} (revised version) #' @export +#' @family utils #' loadLibraries <- function(..., repo = "https://cran.rstudio.com"){ diff --git a/R/setup.R b/R/setup.R index 6baca01..301c11f 100644 --- a/R/setup.R +++ b/R/setup.R @@ -2,6 +2,7 @@ #' #' \code{setup} sources env.R in the repo/project top level folder. #' +#' @import here #' @author Ben Anderson, \email{b.anderson@@soton.ac.uk} #' @export #' @family utils diff --git a/R/tidyNum.R b/R/tidyNum.R index f435e76..8bc5f5e 100644 --- a/R/tidyNum.R +++ b/R/tidyNum.R @@ -6,6 +6,7 @@ #' #' @author Ben Anderson, \email{b.anderson@@soton.ac.uk} #' @export +#' @family utils #' tidyNum <- function(number) { format(number, big.mark=",", scientific=FALSE) diff --git a/man/loadLibraries.Rd b/man/loadLibraries.Rd index 6a0223f..016e3fb 100644 --- a/man/loadLibraries.Rd +++ b/man/loadLibraries.Rd @@ -24,8 +24,14 @@ Especially useful when running on virtual machines where package installation whereas 'library' throws an error if it can't load the package. Hence 'loadLibraries' https://stackoverflow.com/questions/5595512/what-is-the-difference-between-require-and-library } +\seealso{ +Other utils: +\code{\link{setup}()}, +\code{\link{tidyNum}()} +} \author{ Luke Blunden, \email{lsb@soton.ac.uk} (original) Michael Harper \email{m.harper@soton.ac.uk} (revised version) } +\concept{utils} diff --git a/man/setup.Rd b/man/setup.Rd index f1d71e8..a85f7be 100644 --- a/man/setup.Rd +++ b/man/setup.Rd @@ -9,6 +9,11 @@ setup() \description{ \code{setup} sources env.R in the repo/project top level folder. } +\seealso{ +Other utils: +\code{\link{loadLibraries}()}, +\code{\link{tidyNum}()} +} \author{ Ben Anderson, \email{b.anderson@soton.ac.uk} } diff --git a/man/tidyNum.Rd b/man/tidyNum.Rd index a6e08d5..4acfdd6 100644 --- a/man/tidyNum.Rd +++ b/man/tidyNum.Rd @@ -12,6 +12,12 @@ tidyNum(number) \description{ \code{tidyNum} reformats long numbers to include commas and prevents scientific formats } +\seealso{ +Other utils: +\code{\link{loadLibraries}()}, +\code{\link{setup}()} +} \author{ Ben Anderson, \email{b.anderson@soton.ac.uk} } +\concept{utils} -- GitLab