Function reference • dht

User Interface

These functions are used to interact with DeGAUSS container users.

greeting(): display DeGAUSS greeting message in console

check_ram(): check_ram

degauss_colors(): Access the DeGAUSS color palette

Reading and Writing Data

read_lat_lon_csv(): read in and format input file for DeGAUSS container

check_for_column(): check for specified columns and corresponding column types

write_geomarker_file(): write geomarker output to file

Addresses

Tools for cleaning addresses and detecting different common patterns.

clean_address(): clean address text strings for geocoding

address_is_nonaddress(): check if address text is not actually an address

address_is_po_box(): check if address is a PO Box

address_is_institutional(): check if address is a known Cincinnati institutional address

Dates

Validating and calculating dates.

check_dates(): check format of dates from DeGAUSS container input file

check_end_after_start_date(): check that end_date occurs after start_date

expand_dates(): expand dates between start_date and end_date

Running DeGAUSS from R

Run tabular data through DeGAUSS containers from R without using CSV files.

degauss_run(): run a DeGAUSS container

find_docker(): find the path to the docker executable

has_docker(): is docker available?

make_degauss_command(): create a DeGAUSS command

Development and Infrastructure

use_degauss_container() use_degauss_dockerfile() use_degauss_makefile() use_degauss_readme() use_degauss_githook_readme_rmd() use_degauss_entrypoint() use_degauss_dockerignore() use_degauss_tests() use_degauss_license() use_degauss_github_actions(): use DeGAUSS container template

get_degauss_core_lib_env(): get DeGAUSS metadata on all images in the core library

get_degauss_env_dockerfile() get_degauss_env_online(): get DeGAUSS metadata online or from a Dockerfile

core_lib_images(): list the DeGAUSS images in the core library

create_degauss_menu_data(): create data for use in DeGAUSS menu

make_degauss_command(): create a DeGAUSS command

use_degauss_compose(): use DeGAUSS compose file

Deprecated

Functions that are still supported but no longer receive active development, as better solutions now exist.

qlibrary(): wrapper for base::library() that automatically supresses package startup messages

degauss_menu(): DeGAUSS Menu