_pkgdown.yml

url: https://tech.popdata.org/ipumsr/

template:
  bootstrap: 5
  bootswatch: minty
  theme: arrow-light
  bslib:
    primary: "#00263A"
    dropdown-bg: "#f1f5f7"
    dropdown-link-color: "#00263A"
    dropdown-link-hover-bg: "#7a99ac"
    dropdown-link-active-bg: "#00263A"
    dropdown-link-active-color: "white"
    dropdown-border-color: "#c7cacc"
    table-border-color: "#c1d4e0"
    link-color: "#4e6c7d"
    secondary: "#bed2dd"
    base_font: "cabrito_sans_norm_regular"
    heading_font: "cabrito_sans_cond_demi"
    body-color: "#00263a"
    headings-color: "#00263a"
    table-hover-bg: "rgba(17,55,75,0.15)"
    table-bg: "white"
    input-focus-border-color: "#bed2dd"
    input-focus-box-shadow: "0 0 0 0.2rem rgba(190,210,221,0.5)"

development:
  mode: auto

navbar:
  bg: primary
  title: "ipumsr"
  structure:
    left: [intro, reference, articles, news]
    right: [search, github, users, forum]
  components:
    intro:
      text: "Get Started"
      href: articles/ipums.html
    articles:
      text: Articles
      menu:
      - text: "IPUMS Data"
      - text: "Read IPUMS data"
        href: "articles/ipums-read.html"
      - text: "Value labels"
        href: "articles/value-labels.html"
      - text: "Big IPUMS data"
        href: "articles/ipums-bigdata.html"
      - text: "------------------"
      - text: "IPUMS API"
      - text: "Introduction to the API"
        href: "articles/ipums-api.html"
      - text: "Microdata API requests"
        href: "articles/ipums-api-micro.html"
      - text: "NHGIS API requests"
        href: "articles/ipums-api-nhgis.html"
      - text: "------------------"
      - text: "Project-specific exercises"
        href: "https://ipums.org/exercises.shtml"
    users:
      icon: fa-users
      href: https://forum.ipums.org
      aria-label: IPUMS User Forum
    forum:
      icon: fa-globe
      href: https://www.ipums.org/
      aria-label: IPUMS website

home:
  links:
  - text: Ask a question
    href: http://forum.ipums.org

footer:
  structure:
    left: ipums-devel
    right: built_with
  components:
    ipums-devel: |
      Developed by [IPUMS](https://www.ipums.org) at the
      University of Minnesota.

reference:
  - title: "Read IPUMS data"
    desc: "Load IPUMS data and metadata files into R"
  - subtitle: "Microdata projects"
  - contents:
      - read_ipums_micro
      - read_ipums_micro_list
      - read_ipums_ddi
      - read_ipums_micro_chunked
      - read_ipums_micro_list_chunked
      - read_ipums_micro_yield
      - read_ipums_micro_list_yield
  - subtitle: "Aggregate data projects"
  - contents:
      - read_nhgis
      - read_nhgis_codebook
  - subtitle: "General use"
  - contents:
      - read_ipums_sf
      - ipums_list_files
  - title: "Interact with the IPUMS API"
    desc: "Request and download IPUMS data within R"
  - contents:
      - define_extract_micro
      - define_extract_nhgis
      - get_sample_info
      - get_metadata_nhgis
      - submit_extract
      - wait_for_extract
      - download_extract
      - get_extract_info
      - get_extract_history
      - save_extract_as_json
      - define_extract_from_json
      - set_ipums_api_key
      - set_ipums_default_collection
      - ipums_data_collections
      - ipums_extract
      - download_supplemental_data
  - title: "Explore IPUMS variable metadata"
    desc: "Get additional information about IPUMS data contents"
    contents:
      - ipums_var_info
      - ipums_var_desc
      - ipums_var_label
      - ipums_val_labels
      - ipums_file_info
      - ipums_conditions
      - ipums_view
      - ipums_website
  - title: "Work with value labels"
    desc: "Translate IPUMS value labels to standard R data structures"
    contents:
      - lbl_na_if
      - lbl_relabel
      - lbl_collapse
      - lbl_define
      - zap_ipums_attributes
      - lbl_clean
      - lbl_add
      - lbl_add_vals
      - lbl
  - title: "Other helpers"
    desc: "Miscellaneous functions for working with IPUMS data"
    contents:
      - ipums_bind_rows
      - starts_with("ipums_shape")
      - set_ipums_var_attributes
      - ipums_collect
      - ipums_example