Learn R Programming

hipread

hipread (hierarchical IPUMS reader) is a fork from tidyverse readr that allows for reading hierarchical fixed width text files, like those created by the CSPro software and commonly used by census data providers.

Compared to readr it is:

  • Able to natively read the "hierarchical" fixed width file format that IPUMS and some other census data providers use. These files can have multiple types of observations in them, each with their own specification of variables.

  • Better at reading gzipped data. It does not require loading the full file into a raw vector, which takes a large amount of memory, and prevents reading gigantic files altogether (because R can only store raw vectors of a certain size).

  • Less flexible. It only works on fixed width files, only accepts data of types character, double and integer, and is less detailed about the information it gives about parsing failures. This makes it easier for me to maintain.

I do not expect that this will be directly useful for too many people, so the documentation is a little bit light. Instead I expect most users will use this package through the ipumsr package. But, if you are interested and find something confusing, please let me know!

Installation

Install the development version from GitHub with:

# install.packages("devtools")
devtools::install_github("ipumsr/hipread")

Copy Link

Version

Install

install.packages('hipread')

Monthly Downloads

1,570

Version

0.2.4

License

GPL (>= 2) | file LICENSE

Maintainer

Derek Burk

Last Published

November 30th, 2023

Functions in hipread (0.2.4)

hipread_example

Get path to hipread's example datasets
hipread_long_chunked

Read a hierarchical fixed width data file, in chunks
hip_rt

Create a record type information object
hipread_freqs

Calculate frequencies from fixed width file without loading into memory
hipread-package

hipread: Read Hierarchical Fixed Width Files
hipread_long

Read a hierarchical fixed width data file
hipread_long_yield

Read a hierarchical fixed width data file, in yields
hip_fwf_positions

Specify column-specific options for hipread
callback

Callback classes