_pkgdown.yml

url: https://worldfishcenter.github.io/peskas.timor.data.pipeline/

template:
  bootstrap: 5
  bslib:
    primary: '#47475C'
    heading_font:
      google:
        family: Alegreya Sans SC
        wght: 400
    base_font:
      google:
        family: IBM Plex Sans
    code_font:
      google: Fira Mono

reference:
- title: Workflow
  desc: >
    These are arguably the most important functions in the package. Each of
    these functions executes a step in the data pipeline.
- contents:
  - has_keyword("workflow")

- title: Cloud
- subtitle: Cloud storage
  desc: Functions that interact with cloud storage providers.
  contents:
  - matches("cloud")
  - matches("get")
  - matches("ingest")
  - add_version
- subtitle: Google Spreadsheets
  desc: Functions to interact with Google Drive and Spreadsheets
  contents:
  - matches("google")
- subtitle: Airtable
  desc: Functions to interact with Airtable
  contents:
  - matches("air")

- title: Data
- subtitle: Survey
  desc: Functions that help retrieving survey data
- contents:
  - matches("survey")
- subtitle: PDS
  desc: Functions that help retrieving Pelagic Data System data
- contents:
  - matches("pds")
  - kepler_mapper
- subtitle: Data modeling
  desc: Functions dedicated to data modeling.
  contents:
  - matches("model")
- subtitle: Data validation
  desc: Functions dedicated to data validation
  contents:
  - matches("validate")
  - alert_outlier
  - send_validation_mail

- title: Helper functions
- subtitle: Data preprocessing
  desc: Functions dedicated to data processing.
  contents:
  - matches("nest")
  - matches("pt_validate")
  - matches("clean")
  - coalist
  - merge_consecutive_trips
  - join_weights
  - retrieve_lengths
  - fill_missing_regions
- subtitle: Taxonomy
  contents:
  - convert_taxa_names
- subtitle: Utils
  contents:
  - read_config

- title: Data sharing
- subtitle: Publishing
  desc: Functions deemed to share data and reports.
  contents:
  - matches("dataverse")
  - matches("dataset")
  - upload_files
  - generate_metadata
  - generate_description
  - send_sites_report
- subtitle: Utils
  contents:
  - read_config