docs: fix getCitation docs (#110)

philips-software · Jan 17, 2024 · eb87e17 · eb87e17
1 parent 58dd8cc
commit eb87e17
Show file tree

Hide file tree

Showing 5 changed files with 8 additions and 0 deletions.
diff --git a/NAMESPACE b/NAMESPACE
@@ -275,6 +275,7 @@ importFrom(stats,mahalanobis)
 importFrom(stats,model.frame)
 importFrom(stats,weighted.mean)
 importFrom(utils,capture.output)
+importFrom(utils,citation)
 importFrom(utils,combn)
 importFrom(utils,data)
 importFrom(utils,getS3method)

diff --git a/R/generics.R b/R/generics.R
@@ -292,6 +292,7 @@ setGeneric('getArgumentExclusions', function(object, ...) {
 # getCitation ####
 #' @export
 #' @name latrend-generics
+#' @importFrom utils citation
 setGeneric('getCitation', function(object, ...) {
   out <- standardGeneric('getCitation')
 

diff --git a/R/method.R b/R/method.R
@@ -637,9 +637,11 @@ setMethod('getArgumentDefaults', 'lcMethod', function(object) {
 #. getCitation ####
 #' @name getCitation
 #' @rdname getCitation
+#' @aliases getCitation,lcMethod-method
 #' @title Get citation info
 #' @description Get a citation object indicating how to cite the underlying R packages used for estimating or representing the given method or model.
 #' @param object The object
+#' @param ... Additional arguments
 #' @return A [citation] object
 setMethod('getCitation', 'lcMethod', function(object, ...) {
   utils::citation(package = 'base')[0]

diff --git a/R/model.R b/R/model.R
@@ -648,6 +648,7 @@ setMethod('getLabel', 'lcModel', function(object, ...) {
 # . getCitation ####
 #' @export
 #' @rdname getCitation
+#' @aliases getCitation,lcModel-method
 setMethod('getCitation', 'lcModel', function(object, ...) getCitation(getLcMethod(object)))
 
 

diff --git a/man/getCitation.Rd b/man/getCitation.Rd