ipumsr 0.9.0

New features

• This release adds comprehensive support for IPUMS IHGIS extract submission,
  metadata retrieval, and data loading!

  As IPUMS IHGIS is an aggregate data
  project alongside IPUMS NHGIS, many functions that previously were
  NHGIS-specific have been generalized to accommodate both collections. This
  includes the following new functions:

  • read_ipums_agg() loads downloaded extracts for both NHGIS and IHGIS.
    This replaces read_nhgis(), which is now deprecated.

    read_ipums_agg() also includes a new file_encoding argument, as
    IHGIS and NHGIS files often have different encoding. Typically,
    the default file_encoding should load an aggregate data extract
    file correctly. If not, you can adjust the encoding here.

  • define_extract_agg() defines extract requests for both NHGIS and
    IHGIS. Use the collection argument to specify the data collection for
    a given extract. This replaces define_extract_nhgis(), which is now
    deprecated.

  • get_metadata_catalog() retrieves summary metadata about NHGIS and
    IHGIS data sources. get_metadata() retrieves
    detailed metadata about a particular NHGIS or IHGIS data source. These
    functions replace get_metadata_nhgis(), which is now deprecated.

• Adds read_ihgis_codebook() to load codebook files containing
  file-level metadata for downloaded IHGIS extracts. This function is
  currently experimental.

• Enables monetary value adjustment for supported IPUMS USA and IPUMS
  CPS variables. Use the adjust_monetary_values argument to var_spec()
  to include an additional adjusted variable in your extract. See the
  IPUMS CPS
  and IPUMS USA
  documentation for more information on monetary adjustment.

Function + argument retirements

• data_layer and shape_layer arguments are now defunct. In cases
  where this functionality is still supported, please use the
  file_select argument instead.

• get_recent_extracts_info_list(), get_recent_extracts_info_tbl(),
  and extract_tbl_to_list() are now defunct. Use get_extract_history()
  to obtain a list of previously-submitted extracts.

• The ability to read files through directories is now defunct. This
  affects most reader functions. If you have unzipped an IPUMS extract
  archive, please provide the path to the individual file you wish
  to load, not its containing directory.

• project and var_label arguments in ipums_website() are now
  defunct.

ipumsr 0.8.2

• Adds codebook files to output of ipums_list_files() (#85).

• Removes deprecated ipums_list_files() arguments data_layer,
  shape_layer, and raster_layer. Use file_select instead. Also removes
  support for listing raster file types (#85).

• The "*" wildcard is no longer required to select all geographic_extents
  in define_extract_nhgis(). Instead, all available geographic extents
  are selected by default. The "*" syntax is still supported.

• Adds download_supplemental_data() to enable access to supplemental
  data files via the IPUMS API (#83).

• Fixed bug in shape_join.R that would always give the result of a
  right join no matter whether ipums_shape_left_join() or
  ipums_shape_right_join() was used (#82) (thanks @JiaZhang42!).

ipumsr 0.8.1

Minor improvements and fixes

• Small fix to vignette that was previously throwing an error in R CMD Check
  with --no-manual and --no-build-vignettes options (#80).

ipumsr 0.8.0

Breaking changes + deprecations

• Collection-specific definition functions for IPUMS microdata projects
  have been deprecated in favor of define_extract_micro(). This
  streamlines syntax across all supported microdata collections. Use the
  collection argument to specify the collection for your
  microdata extract.

  IPUMS NHGIS extracts are still created with
  define_extract_nhgis().

• Previously deprecated methods for retrieving extract history are now
  defunct. Use get_extract_history() instead.

New features

• Adds support for IPUMS API extract endpoints for IPUMS Time Use and
  IPUMS Health Surveys projects! This includes:

  • IPUMS Time Use

    • IPUMS ATUS ("atus")

    • IPUMS AHTUS ("ahtus")

    • IPUMS MTUS ("mtus")

  • IPUMS Health Surveys

    • IPUMS NHIS ("nhis")

    • IPUMS MEPS ("meps")

• Adds support for new rectangularization options for certain
  microdata collections. Use the rectagular_on argument in your
  extract definition to rectangularize on records other than person
  ("P") records.

• Time use variables can be included in IPUMS Time Use extracts. Use
  the tu_var_spec() helper with the time_use_variables argument of
  define_extract_micro() to create a time use variable
  specification.

  This includes both IPUMS-defined and user-defined time use variables. Note
  that user-defined time use variables cannot currently be created via API.
  However, if you have defined a time use variable through the IPUMS web
  interface, you can request it in an extract via API.

• Sample members can be specified in IPUMS ATUS extracts. Use the
  sample_members argument of define_extract_micro() to do so.

• "household_only" is now a supported value for data_structure in
  IPUMS USA extracts.

Minor improvements and fixes

• Fixes bug in add_to_extract.micro_extract() that caused an error if a user
  attempted to update the value of data_quality_flags in a detailed variable
  specification.

ipumsr 0.7.2

• Fix for CRAN checks

ipumsr 0.7.1

• Minor updates to README and vignettes

ipumsr 0.7.0

Function retirements

• ipumsr no longer suggests raster, rgdal, and sp (#23). Removing these
  dependencies requires the retirement of several previously deprecated
  functions:

  • All read_terra_*() functions
  • read_ipums_sp() (use read_ipums_sf() to load spatial data in sf format)
  • read_ipums_codebook() (use read_nhgis_codebook() to load an NHGIS
    codebook)
  • ipums_list_*() helper functions (instead, use ipums_list_files())
  • read_nhgis_sf() and read_nhgis_sp() (instead, use read_ipums_sf() and
    read_nhgis() to load spatial and tabular data separately, then join
    with an ipums_shape_join_*() function)

Other updates

• Fixes bug in ipums_view() where content would not display properly in
  viewer pane (#19)

• RStudio is now explicitly required to launch files in the viewer pane using
  ipums_view(). R console users can still generate stand-alone HTML files
  that can be viewed in a different browser.

• Updates the UI and fixes various bugs in ipums_website() (#54):

  • Accepted project names are now consistent with those provided in
    ipums_ddi objects. Shorthand project names as used by the IPUMS API are
    also accepted.
  • Users can now use the same syntax regardless of whether providing
    an ipums_ddi object or a project name. The project argument has been
    deprecated.
  • MacOS is now supported
  • The var argument is no longer required. Omitting var will launch the
    URL to the homepage for the specified IPUMS project.
  • The homepage_if_missing argument now defaults to FALSE.
  • The var_label argument has been deprecated

• Updates IPUMS projects listed in ipums_data_collections().

• Various documentation updates

ipumsr 0.6.3

• The ability to read an IPUMS DDI file contained within a zip archive using
  read_ipums_ddi() has been deprecated. Users must now load DDI files by
  providing the direct path to the uncompressed .xml file.

  This resolves an inconsistency between the behavior
  of read_ipums_micro_*() functions when provided a DDI file path as compared to
  an ipums_ddi object created with read_ipums_ddi().

• The ability to read IPUMS files by providing the path to their containing
  directory has been deprecated. This affects:

  • read_nhgis()
  • read_ipums_sf()
  • read_nhgis_codebook()
  • read_ipums_ddi()
  • ipums_list_files()

  These functions now require either a zip archive (with the exception of
  read_ipums_ddi()—see above) or a direct file path as input.

  This has the consequence that read_ipums_sf() with bind_multiple = TRUE
  requires a zip archive as input if multiple files are to be read and combined.

• Documentation updates for clarity

ipumsr 0.6.2

• Fixes for CRAN checks.

ipumsr 0.6.1

Fixes for CRAN checks