_pkgdown.yml

url: samabbott.co.uk/getTBinR/
template:
  params:
    bootswatch: lumen
    docsearch:
      api_key: 6c737a6c632ea7eab75c912a6b07b5f1
      index_name: gettbinr

development:
  mode: release
  
navbar:
  type: inverse
  left:
    - text: "Home"
      href: index.html
    - text: "Getting Started"
      href: articles/intro.html
    - text: "Case Studies"
      menu:
      - text: Exploring Global Trends in Tuberculosis Incidence Rates
        href: articles/case_study_global_trends.html
      - text: Exploring Estimates of the Tuberculosis Case Fatality Ratio
        href: articles/case_fatality_rate.html
    - text: "Dashboards"
      menu:
      - text: Explore Global Tuberculosis
        href: http://www.seabbs.co.uk/shiny/ExploreGlobalTB/
    - text: News
      menu:
      - text: "Blog posts"
        href: https://www.samabbott.co.uk/tags/who/
      - text: "------------------"
      - text: "Change log"
        href: news/index.html
    - icon: fa-file-code-o 
      text: "Functions"
      href: reference/index.html
        
reference:
    - title: Get WHO Tuberculosis Data
      desc:  Retrieve or load the WHO data into R
      contents:
      - starts_with("get_")
    - title: Summarise WHO Tuberculosis Data
      desc: Get useful regional and global summaries of TB metrics
      contents:
      - starts_with("summarise_")
    - title: Map WHO Tuberculosis Data
      desc: Make maps of the WHO tuberculois data
      contents:
      - starts_with("map_")
    - title: Plot WHO Tuberculosis Data
      desc: Generate exploratory plots of the WHO Tuberulosis data.
      contents:
      - starts_with("plot_")
    - title: Dashboards
      desc: Launch interactive dashboards showcasing package functionality. These dashboards require the shiny package.
      contents:
      - starts_with("run_")
    - title: Reports
      desc: Render parameterised reports showcasing package functionality. These reports require the rmarkdown package.
      contents:
      - starts_with("render_")
    - title: Themes and Palettes 
      desc: Customised `{ggplot2} themes and colour palettes.
      contents:
      - starts_with("theme")
      - who_palettes
      - starts_with("scale_")
      - for_presentation
    - title: Helpers
      contents:
      - search_data_dict
      - prepare_df_plot
    - title: Package Data
      desc: Data supplied with the package.
      contents:
      - available_datasets
      - who_shapefile