_pkgdown.yml

url: http://tech.popdata.org/ipumsr/
template:
  params:
    docsearch:
      api_key: 4ffa912ace97d2493f6ed39f20e94316
      index_name: ipumsr
footer:
  structure:
    left: Developed by [IPUMS](https://www.ipums.org) at the University of Minnesota
    right: built_with
development:
  mode: auto
navbar:
  title: "ipumsr"
  type: inverse
  left:
    - icon: "fa-home"
      href: index.html
    - text: "Introduction"
      href: "articles/ipums.html"
    - text: "Reference"
      href: "reference/index.html"
    - text: "Articles"
      menu:
      - 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: "Interact with the IPUMS API"
        href: "articles/ipums-api.html"
      - text: "------------------"
      - text: "Project-specific exercises"
        href: "https://ipums.org/exercises.shtml"
    - text: "Changelog"
      href: "news/index.html"
  right:
    - icon: fa-github
      href: https://github.com/ipums/ipumsr
    - icon: fa-users
      href: https://forum.ipums.org
    - icon: fa-globe
      href: https://www.ipums.org/
home:
  links:
  - text: Ask a question
    href: http://forum.ipums.org
reference:
  - title: "Read IPUMS microdata"
    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
      - read_ipums_sf
      - ipums_list_files
  - title: "Read IPUMS aggregate data"
  - contents:
      - read_nhgis
      - read_nhgis_codebook
      - read_ipums_sf
      - ipums_list_files
  - title: "Interact with the IPUMS API"
    contents:
      - set_ipums_api_key
      - set_ipums_default_collection
      - define_extract_usa
      - define_extract_cps
      - define_extract_nhgis
      - submit_extract
      - get_extract_info
      - download_extract
      - wait_for_extract
      - is_extract_ready
      - add_to_extract
      - remove_from_extract
      - combine_extracts
      - save_extract_as_json
      - define_extract_from_json
      - get_nhgis_metadata
      - ipums_extract
      - ipums_data_collections
      - extract_tbl_to_list
  - title: "Explore IPUMS variable metadata"
    contents:
      - ipums_view
      - ipums_var_info
      - ipums_var_desc
      - ipums_var_label
      - ipums_val_labels
      - ipums_website
      - ipums_conditions
      - ipums_file_info
  - 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 other helper functions for working with IPUMS data"
    contents:
      - ipums_bind_rows
      - ipums_collect
      - ipums_example
      - starts_with("ipums_shape")
      - join_failures
      - set_ipums_var_attributes
      - selection_language