Skip to contents

map_headernames provides metadata about all indicators in EJSCREEN / EJAM

Source: R/data_map_headernames.R
map_headernames.Rd

map_headernames provides metadata about all indicators in EJSCREEN / EJAM

Usage

map_headernames

Format

An object of class data.frame with 952 rows and 47 columns.

Details

This is an IMPORTANT TABLE and many functions rely on it.

It provides metadata or information about each variable (indicator), such as the following:

  • names as used in the R code ("rname"), which is the "canonical" name for each variable, and is used in the R code and in the EJAM API

  • names as used in short labels of graphics

  • names as used in table headers (long versions to provide full descriptions of the variables)

  • names as used in EJSCREEN-specific files/code/app (ejscreen_indicator)

  • row-type flags that indicate if a variable is in various categories or types

  • main category of variable or "varlist" for purposes of grouping similar ones like those in names_e, names_d, or names_d_pctile

  • info about rounding decimal places, significant digits, percentage format, etc.

  • method for aggregating the value across blockgroups (sum, weighted mean, what is the weight, etc.)

  • other information like sort order for certain purposes, etc.

It was originally created from a spreadsheet of the same name in the data-raw folder. The current editable source is data-raw/map_headernames.csv; the rebuild script should read that CSV, validate it, and save this package data object without adding or changing metadata rows in code.

Several helper functions are used to query it, such as fixcolnames() and varinfo().

You can see examples of what it contains below.

data.frame(t(map_headernames[1:2, ]))

See also

varinfo() fixcolnames() varin_map_headernames() varlist2names()

Examples

  #   See how many variables are on each list, for example:
  # \donttest{
  data.table::setDT(data.table::copy(map_headernames))[, .(
    variables = .N,
    has_csvname = sum(csvname != ""),
    has_ejscreen_indicator = sum(ejscreen_indicator != ""),
    has_ejscreen_apinames_old = sum(ejscreen_apinames_old != ""),
    has_ejam_apinames = sum(ejam_apinames != ""),
    has_acsname = sum(acsname != "")
    ),
 keyby = c("raw_pctile_avg", "DEJ", "ratio.to", "pctile.", "avg.",  "varlist" )]

 # Which sources provide which key variables or indicators?

 some <- unique(map_headernames$rname[map_headernames$varlist != ""
   & map_headernames$varlist != "x_anyother"])

 info <- cbind(
   varinfo(some, info = c('ejscreen_apinames_old', 'csv', 'acs', 'varlist')),
   usastats = some %in% names(usastats),
   statestats = some %in% names(statestats))
 info <- info[nchar(paste0(info$ejscreen_apinames_old, info$csv, info$acs)) > 0, ]
 info

 # any others

 some <- unique(map_headernames$rname[map_headernames$varlist != ""
   & map_headernames$varlist == "x_anyother"])

 info <- cbind(
   varinfo(some, info = c('ejscreen_apinames_old', 'csv', 'acs', 'varlist')),
   usastats = some %in% names(usastats),
   statestats = some %in% names(statestats))
 info <- info[nchar(paste0(info$ejscreen_apinames_old, info$csv, info$acs)) > 0, ]
 info
  # }