_pkgdown.yml

destination: docs

development:
  mode: auto

template:
  bootstrap: 5
  params:
    bootswatch: flatly

reference:
  - title: Configuration
    desc: >
      Read configuration data
    contents:
    - getConfig

  - title: Database
    desc: >
      Handle database connections and queries
    contents:
    - loadRegData
    - rapOpenDbConnection
    - rapCloseDbConnection

  - title: Staging data
    desc: >
      Handle staging data
    contents:
    - saveStagingData
    - loadStagingData
    - deleteStagingData
    - cleanStagingData

  - title: User information
    desc: >
      Provides information on the logged in user in a shiny session
    contents:
    - getUserName
    - getUserGroups
    - getUserRole
    - getUserReshId
    - getUserFullName
    - getUserPhone
    - getUserEmail
    - userInfo
    - unitAttribute
    - userAttribute

  - title: Logging
    desc: >
      Handle logging
    contents:
    - logger
    - sanitizeLog

  - title: Automated reports
    desc: >
      Handle automated reports
    contents:
    - readAutoReportData
    - writeAutoReportData
    - upgradeAutoReportData
    - runAutoReport
    - runBulletin
    - createAutoReport
    - deleteAutoReport
    - makeAutoReportTab
    - makeRunDayOfYearSequence
    - isPkgRapReg
    - getRegs
    - findNextRunDate
    - filterAutoRep
    - autoReport
    - .testAutoReport
    - .getFun

  - title: Shiny
    desc: >
      Helper functions to be used by shiny apps
    contents:
    - navbarWidget
    - appNavbarUserWidget
    - exportGuide
    - statsGuide
    - export
    - stats

  - title: Miscellaneous
    desc: >
      Various tools
    contents:
    - halloRapporteket
    - fireInTheHole
    - sendEmail
    - howWeDealWithPersonalData
    - runNoweb
    - getRapPackages
    - isRapContext
    - noOptOutOk
    - renderRmd
    - makeStandardTable
    - getGithub

  - title: Data
    desc: >
      Data contained by the package
    contents:
    - appLog

  - title: Meta
    desc: >
      About the package
    contents:
    - rapbase