Correct documentation

epinowcast · Jul 12, 2024 · bff8c10 · bff8c10
1 parent 42ff019
commit bff8c10
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 5 deletions.
diff --git a/R/generics.R b/R/generics.R
@@ -1,5 +1,6 @@
 #' Validate
 #'
+#' @param data A dataframe to be used for modelling.
 #' @family generics
 #' @export
 epidist_validate <- function(data) {
@@ -8,7 +9,7 @@ epidist_validate <- function(data) {
 
 #' Define a model specific formula
 #'
-#' @param data A dataframe to be used for modelling.
+#' @inheritParams epidist_validate
 #' @param ... Additional arguments for method.
 #' @family generics
 #' @export
@@ -18,7 +19,7 @@ epidist_formula <- function(data, ...) {
 
 #' Define model specific family
 #'
-#' @inheritParams epidist_formula
+#' @inheritParams epidist_validate
 #' @param ... Additional arguments for method.
 #' @family generics
 #' @export
@@ -28,7 +29,7 @@ epidist_family <- function(data, ...) {
 
 #' Define model specific priors
 #'
-#' @inheritParams epidist_formula
+#' @inheritParams epidist_validate
 #' @param ... Additional arguments for method.
 #' @rdname epidist_prior
 #' @family generics
@@ -39,7 +40,7 @@ epidist_prior <- function(data, ...) {
 
 #' Define model specific Stan code
 #'
-#' @inheritParams epidist_formula
+#' @inheritParams epidist_validate
 #' @param ... Additional arguments for method.
 #' @rdname epidist_stancode
 #' @family generics
@@ -55,7 +56,7 @@ epidist_stancode <- function(data, ...) {
 #' @param prior ...
 #' @param fn Likely `brms::brm`. Also possible to be `brms::make_stancode` or
 #' `brms::make_standata`.
-#' @inheritParams epidist_formula
+#' @inheritParams epidist_validate
 #' @param ... Additional arguments for method.
 #' @family generics
 #' @export

diff --git a/man/epidist_validate.Rd b/man/epidist_validate.Rd
diff --git a/man/epidist_validate.default.Rd b/man/epidist_validate.default.Rd