Skip to content

Commit

Permalink
docs(pkgdown): Add structure to the docs site
Browse files Browse the repository at this point in the history
  • Loading branch information
RasmusSkytte committed Jun 3, 2024
1 parent 67fe6ea commit c23f071
Show file tree
Hide file tree
Showing 7 changed files with 35 additions and 0 deletions.
1 change: 1 addition & 0 deletions R/DiseasyActivity.R
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
1 change: 1 addition & 0 deletions R/DiseasyObservables.R
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
1 change: 1 addition & 0 deletions R/DiseasySeason.R
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
29 changes: 29 additions & 0 deletions _pkgdown.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,32 @@ authors:
href: https://www.ssi.dk/
html: >-
<img src="https://www.ssi.dk/assets/images/ssi-logo-optimeret.svg" alt="SSI" height="64" style="margin-bottom: 0.5em; margin-top: 1.5em;" />
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
1 change: 1 addition & 0 deletions man/DiseasyActivity.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions man/DiseasyObservables.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions man/DiseasySeason.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit c23f071

Please sign in to comment.