DeGAUSS Metadata Specifications

Metadata Elements

The below list contains the names of supported metadata elements captured using environment variables defined using ENV instructions inside the Dockerfile:

  • degauss_name: name of DeGAUSS container (use only lower case letters and underscores)
  • degauss_version: version number corresponding to GitHub release and latest version of container available from the GitHub Container Registry
  • degauss_description: a short (< 50 characters) description that finishes the sentence “This container returns …”
  • degauss_argument: name and default value of any argument short argument description [default: x]

Defining Metadata Environment Variables in the Dockerfile

  • The template Dockerfile from {dht} (dht::use_degauss_dockerfile()) comes with the above four (but with commented out ENV instructions for specifying an optional command line argument)
  • Each ENV must be on its own line and only define one variable at a time
  • In general, any ENV instruction that begins with degauss_ can/will be read in by dht::get_degauss_env_dockerfile() or dht::get_degauss_env_online()

Getting Metadata About A DeGAUSS Image Online

Get information about one single DeGAUSS image:

dht::get_degauss_env_online("fortunes")
##                             degauss_name 
##                               "fortunes" 
##                          degauss_version 
##                                  "0.1.3" 
##                      degauss_description 
##                          "random quotes" 
##                         degauss_argument 
## "number of quotes to print [default: 1]"

or get a table of information about the images in the core library

core_info <- dht::get_degauss_core_lib_env()
## ℹ downloading latest information about images in core library...
## ✔ find more at <https://degauss.org/available_images>
## downloading latest information about images in core library... ■■■■■■■■■■■■■■■■…
knitr::kable(core_info)
degauss_name degauss_version degauss_description degauss_argument
geocoder 3.4.1 geocodes valid_geocode_score_threshold [default: 0.5]
census_block_group 1.1.1 census block group and tract census year [default: 2010]
dep_index 0.2.2 census tract-level deprivation index NA
greenspace 0.3.1 enhanced vegetation index NA
roads 0.2.3 proximity and length of major roads buffer radius in meters [default: 400]
aadt 0.2.2 average annual daily traffic buffer radius in meters [default: 400]
nlcd 1.0.1 land cover fractional imperviousness buffer radius in meters [default: 400]
drivetime 1.4.0 distance and drive time to care sites care_site [default: none]
st_census_tract 0.2.3 census tract identifiers with appropriate vintage NA
pm 0.2.0 daily PM2.5 NA
narr 1.0.0 daily weather data (temperature, humidity, etc) NARR variables to be returned (weather, wind, atmosphere, or precippres) [default: weather]