diff --git a/R/DiseasyActivity.R b/R/DiseasyActivity.R index 4910ae0a..46a8a160 100644 --- a/R/DiseasyActivity.R +++ b/R/DiseasyActivity.R @@ -46,6 +46,7 @@ #' @return #' A new instance of the `DiseasyActivity` [R6][R6::R6Class] class. #' @importFrom Matrix sparseMatrix +#' @keywords functional-module #' @export DiseasyActivity <- R6::R6Class( # nolint: object_name_linter classname = "DiseasyActivity", diff --git a/R/DiseasyObservables.R b/R/DiseasyObservables.R index 59544156..28e2a76d 100644 --- a/R/DiseasyObservables.R +++ b/R/DiseasyObservables.R @@ -25,6 +25,7 @@ #' rm(obs) #' @return #' A new instance of the `DiseasyBaseModule` [R6][R6::R6Class] class. +#' @keywords functional-module #' @export DiseasyObservables <- R6::R6Class( # nolint: object_name_linter classname = "DiseasyObservables", diff --git a/R/DiseasySeason.R b/R/DiseasySeason.R index 9f5627fb..3cd5277b 100644 --- a/R/DiseasySeason.R +++ b/R/DiseasySeason.R @@ -25,6 +25,7 @@ #' rm(s1, s2) #' @return #' A new instance of the `DiseasySeason` [R6][R6::R6Class] class. +#' @keywords functional-module #' @export DiseasySeason <- R6::R6Class( # nolint: object_name_linter classname = "DiseasySeason", diff --git a/_pkgdown.yml b/_pkgdown.yml index 35082858..504d5dce 100644 --- a/_pkgdown.yml +++ b/_pkgdown.yml @@ -7,3 +7,32 @@ authors: href: https://www.ssi.dk/ html: >- SSI + +reference: + - title: Functional modules + desc: The building blocks of diseasy. + contents: + - has_keyword("functional-module") + + - title: Data sets + desc: Data for the functional modules + contents: + - has_keyword("data") + + - title: Developer functions + desc: Functions to create model templates. + contents: + - DiseasyBaseModule + - DiseasyModel + - diseasyoption + +articles: +- title: Functional modules + navbar: Functional modules + contents: + - starts_with("diseasy") + +- title: Developer guides + navbar: Developer guides + contents: + - creating-a-model diff --git a/man/DiseasyActivity.Rd b/man/DiseasyActivity.Rd index 6494c9f6..5d53f768 100644 --- a/man/DiseasyActivity.Rd +++ b/man/DiseasyActivity.Rd @@ -54,6 +54,7 @@ See vignette("diseasy-activity") for examples of use. \seealso{ \link{dk_activity_units} } +\keyword{functional-module} \section{Super class}{ \code{\link[diseasy:DiseasyBaseModule]{diseasy::DiseasyBaseModule}} -> \code{DiseasyActivity} } diff --git a/man/DiseasyObservables.Rd b/man/DiseasyObservables.Rd index e01695d6..2a465d51 100644 --- a/man/DiseasyObservables.Rd +++ b/man/DiseasyObservables.Rd @@ -40,6 +40,7 @@ See vignette("diseasy-observables") \link[SCDB:get_table]{SCDB::get_table} } +\keyword{functional-module} \section{Super class}{ \code{\link[diseasy:DiseasyBaseModule]{diseasy::DiseasyBaseModule}} -> \code{DiseasyObservables} } diff --git a/man/DiseasySeason.Rd b/man/DiseasySeason.Rd index dfb45d28..77d57cbb 100644 --- a/man/DiseasySeason.Rd +++ b/man/DiseasySeason.Rd @@ -34,6 +34,7 @@ See the vignette("diseasy-season") for examples of use. \seealso{ \link{DiseasyObservables} } +\keyword{functional-module} \section{Super class}{ \code{\link[diseasy:DiseasyBaseModule]{diseasy::DiseasyBaseModule}} -> \code{DiseasySeason} }