_pkgdown.yml

url: https://ouhscbbmc.github.io/REDCapR

template:
  bootstrap: 5
  params:
    bootswatch: simplex
    docsearch:
      api_key: d672935e2d904316d6ee40239317764e
      index_name: redcapr

home:
  links:
#  - text: Ask a question
#    href: https://discourse.mc-stan.org/

development:
  mode: release

navbar:
  title: "REDCapR"
  type: inverse

articles:
  - title: "Getting Started"
    desc: >
      These vignettes provide an introduction to REDCapR.
    contents:
      - workflow-read
      - BasicREDCapROperations
      - SecurityDatabase
      - TroubleshootingApiCalls
      - advanced-redcapr-operations
      - longitudinal-and-repeating
      - workflow-write
reference:

  - title: "Records via the API"
    desc: >
      Reading and writing REDCap records, and files within a record.
    contents:
      - redcap_read
      - redcap_read_oneshot
      - redcap_read_oneshot_eav
      - redcap_read_eav_oneshot
      - redcap_write
      - redcap_write_oneshot
      - redcap_delete
      - redcap_report

  - title: "File API Operations"
    desc: >
      Manipulating files in the REDCap records and in the file repository.
    contents:
      - redcap_file_download_oneshot
      - redcap_file_upload_oneshot
      - redcap_file_repo_list_oneshot

  - title: "Additional API Methods"
    desc: >
      Accessing other information from the REDCap project or server.
    contents:
      - redcap_arm_export
      - redcap_dag_read
      - redcap_event_instruments
      - redcap_event_read
      - redcap_instrument_download
      - redcap_instruments
      - redcap_log_read
      - redcap_metadata_coltypes
      - redcap_metadata_read
      - redcap_metadata_write
      - redcap_next_free_record_name
      - redcap_project_info_read
      - redcap_survey_link_export_oneshot
      - redcap_users_export
      - redcap_variables
      - redcap_version

  - title: "Internals"
    desc: >
      Functions and classes used by the methods above.
    contents:
      - REDCapR-package
      - redcap_project
      - to_api_array
      - kernel_api

  - title: "Security"
    desc: >
      Responsibly store and retrieve a user's project-specific token.
    contents:
      - retrieve_credential

  - title: "Utilities"
    desc: >
      Functions to help the methods above.
    contents:
      - collapse_vector
      - constant
      - create_batch_glossary
      - metadata_utilities
      - redcap_column_sanitize
      - replace_nas_with_explicit
      - sanitize_token
      - validate

  - title: "Soft Deprecated"
    desc: >
      Functions that have been renamed and will be removed in future REDCapR versions.
    contents:
      - redcap_download_file_oneshot
      - redcap_upload_file_oneshot
      - redcap_download_instrument