_pkgdown.yml

url: https://qtalr.github.io/qtalrkit/
title: "qtalrkit"
template:
  bootstrap: 5
  bslib:
    primary: "#18bc9c"

navbar:
  structure:
    left:
      - intro
      - articles
      - reference
    right:
      - search
      - news
      - github
  components:
    articles:
      text: Materials
      href: articles/index.html
    reference:
      text: Reference
      href: reference/index.html
    github:
      icon: fab fa-github fa-lg
      href: https://github.com/qtalr/qtalrkit/
      aria-label: github
    news:
      text: News
      href: news/index.html

articles:
  - title: Recipes
    desc: "A collection of programming demonstrations"
    contents:
      # - qtalrkit
      - articles/recipe-0 # Preface/ Writing with code
      - articles/recipe-1 # Chapter 1/ Academic writing with Quarto
      - articles/recipe-2 # Chapter 2/ Reading, inspecting, and writing data
      - articles/recipe-3 # Chapter 3/ Descriptive assessment of datasets
      - articles/recipe-4 # Chapter 4/ Scaffolding a research project
      - articles/recipe-5 # Chapter 5/ Collecting and documenting data
      - articles/recipe-6 # Chapter 6/ Organizing and documenting data
      - articles/recipe-7 # Chapter 7/ Transforming and documenting data
      - articles/recipe-8 # Chapter 8/ Exploratory analysis methods
      - articles/recipe-9 # Chapter 9/ Building predictive models
      - articles/recipe-10 # Chapter 10/ Building inference models
      - articles/recipe-11 # Chapter 11/ Sharing research
  - title: Guides
    desc: "A collection of guides for using R and related tools"
    contents:
      - articles/guide-1 # Setting up R environment
      - articles/guide-2 # Setting up Git and GitHub
      - articles/guide-3 # Reproducible examples
      - articles/guide-4 # Identifying data sources
      - articles/guide-5 # Web scraping with R
  - title: Errata
    desc: "A collection of errata"
    contents:
      - articles/errata # Errata
  - title: Materials
    desc: "A collection of materials for instructors"
    contents:
      - articles/instructor-guide # Instructor guide

reference:
  - title: "Inspection functions"
    desc: "Functions to inspect data"
    contents:
      - find_outliers           # outlier detection
  - title: "Statistical functions"
    desc: "Functions to perform statistical analyses"
    contents:
      - calc_assoc_metrics      # association metrics (pmi, dice, G)
      - calc_normalized_entropy # dispersion for categorical data
      - calc_type_metrics       # type metrics (frequency, dispersion)
  - title: "Data functions"
    desc: "Functions to manage data"
    contents:
      - create_data_dictionary  # data dictionary file structure/ contents
      - create_data_origin      # data origin file structure
      - curate_enntt_data       # curate Europarl Corpus Native, Non...
      - curate_swda_data        # curate Switchboard Dialog Act Corpus
      - get_compressed_data     # download and decompress data
      - get_gutenberg_works     # interface to Project Gutenberg API
      - get_talkbank_data       # interface to TalkBank API
  - title: "Publishing functions"
    desc: "Functions to publish data"
    contents:
      - add_pkg_to_bib          # add package citation info to .bib file

footer:
  structure:
    left: developed_by
    right: built_with