_pkgdown.yml

url: https://rOpenSpain.github.io/spanishoddata/
template:
  bootstrap: 5
  package: rostemplate

  opengraph:
    image:
      src: man/figures/card.png

authors:
  Egor Kotov:
    href: "https://www.ekotov.pro"
  Robin Lovelace:
    href: "https://www.robinlovelace.net/"

articles:
- title: Documentation
  navbar: ~
  contents:
  - v1-2020-2021-mitma-data-codebook
  - v2-2022-onwards-mitma-data-codebook
  - convert
  - disaggregation
  - flowmaps-static
  - flowmaps-interactive

navbar:
  structure:
    left:  [intro, reference, articles, tutorials, news]
    right: [search, github, lightswitch]

reference:
  - title: "Analysing up to 1 week of data"
    desc: >
      Quickly download and analyse just a few days of mobility data
    contents:
      - spod_get_zones
      - spod_get
      - spod_disconnect
  - title: "Analysing long time periods (months or even years)"
    desc: >
      Download data for longer periods, convert them into analysis ready format such as `DuckDB` or `Parquet` for out-of-memory analysis of this large data
    contents:
      - spod_get_zones
      - spod_download
      - spod_convert
      - spod_connect
      - spod_disconnect
  - title: "Helper functions"
    contents:
      - spod_codebook
      - spod_available_data
      - spod_get_valid_dates
      - spod_set_data_dir
      - spod_get_data_dir