_pkgdown.yml

url: https://core.dymium.org
destination: docs

template:
  params:
    docsearch:
      api_key: 5b9cd61032daf2c5966b7cd693157aa2
      index_name: dymiumcore
    ganalytics: UA-158512288-1
    bootswatch: readable

home:
  title: A toolbox for building a dynamic microsimulation model in R.

toc:
  depth: 2

navbar:
  structure:
      left:  [home, introduction, reference, articles, news]
      right: [github]
  components:
    home:
      icon: fas fa-home fa-lg
      href: index.html
    introduction:
      text: Introduction
      href: articles/dymium-intro.html
    articles:
      text: Articles
      menu:
        - text: "Why another microsimulation package?"
          href: articles/why-another-microsim.html
        - text: Publications
          href: articles/publications.html
        - text: 'Manual'
        - text: 'For developers (Work in progress)'
          href: articles/for-developers.html
        - text: 'For modellers'
          href: articles/for-modellers.html
        - text: 'For end users (Work in progress)'
          href: articles/for-endusers.html
        - text: 'Use cases'
        - text: 'Residential mobility'
          href: articles/residential-mobility.html
        - text: 'Mate matching'
          href: articles/mate-matching.html
        - text: 'Marital status'
          href: articles/marital-status.html
    news:
      text: News
      href: news/index.html


reference:
- title: Entities
  desc:
  contents:
    - Entity
    - Agent
    - Individual
    - Household
    - Firm
    - Asset
    - starts_with("Building")
    - Environment
    - Zone
    - Network
- title: Containers
  contents:
    - Container
    - World
    - Population
    - matches("^Model.")
    - pop_register
    - starts_with("makeModel")
- title: Simulation tools
  contents:
    - matches("^Trans.")
    - transition
    - mutate_entity
    - add_entity
    - remove_entity
    - SupportedTransitionModels
    - Target
    - simulate_choice
    - alignment
    - Pipeline
    - register
    - starts_with("Match")
    - starts_with("simulate_choice")
- title: Logging and inspection
  contents:
    - add_log
    - get_log
    - add_history
    - get_history
    - combine_histories
    - plot_history
    - inspect
- title: Data backends
  contents:
    - matches("DataBackend.")
- title: "Module"
  desc: "Manage,create and download modules."
  contents:
    - check_module
    - check_module_version
    - download_module
    - get_all_module_files
    - get_modules
    - get_module_files
    - get_module_versions
    - use_module
    - use_module_readme
- title: "Event"
  desc: creates an event script and handy functions to use within event functions.
  contents:
    - use_event
    - get_models
    - pick_models
    - is_scheduled
- title: "Scenario"
  desc: Scenario is a recommended way to organise the scripts, the data, and the models that are belong to a microsimulation implementation.
  contents:
    - create_scenario
    - get_active_scenario
    - set_active_scenario
- title: "Toy data"
  desc: "Data for testing purposes."
  contents:
    - starts_with("toy_")
    - starts_with("create_toy")
- title: Checkmate functions
  contents:
    - starts_with("check_")
    - starts_with("assert_")
    - starts_with("test_")
    - starts_with("expect_")
- title: "Miscellaneous"
  contents:
    - extract_data
    - starts_with("dm_")
    - .get_sim_time
    - omit_derived_vars
    - normalise_derived_vars
    - sample_choice
    - lookup_and_replace
    - lookup_and_replace2
    - condense_rows
    - element_wise_expand_lists
    - unnest_dt
    - dt_group_and_sort
    - validate_linkages
    - is_dymium_class
    - sim
    - dsample

- title: Base classes
  contents:
    - Generic
    - Entity
    - Trans
    - DataBackend
    - ContainerGeneric