read_undata_files: Combine together downloaded undata files

In ihmeuw-demographics/demUtils: Utility functions for demographic data

Combine together downloaded undata files

Description

Combine together downloaded undata files

Usage

read_undata_files(
  fpaths,
  n_footnote_col = 2,
  data_footnoteid_col = "Value Footnotes",
  footnoteid_col = "footnoteSeqID",
  footnote_col = "Footnote"
)

Arguments

fpaths	[character()] Path to separate undata files to combine together. Output of download_undata_table.
n_footnote_col	[numeric(1)] Column number of the 'data' table where the footnote_col is also stored. Default is '2'.
data_footnoteid_col	[character(1)] Name of column in the data table storing the id number. Default is 'Value Footnotes'.
footnoteid_col	[character(1)] Name of column in the footnote table storing the id number. Default is 'footnoteSeqID'.
footnote_col	[character(1)] Name of column in the footnote table storing the text. Default is 'Footnote'.

Details

undata tables contain the standard dataset included in the online tables plus sometimes a table at the bottom containing footnotes. This function

Value

[data.table(1)] with all data from input paths combined together.

Examples

## Not run: 
data <- read_undata_files

## End(Not run)

ihmeuw-demographics/demUtils documentation built on Feb. 27, 2024, 1:25 p.m.