Package index • dimex

All functions

cat_info_sep(): Print an informational message with a preceding blank line

cat_rule_sep(): Print an informational 'separator' rule with a preceding blank line

cfg_keys_all_valid(): Check if config has any invalid keys

collate_results_jul_2021(): Collate results for July 2021

collate_results_q1_2021(): Collate results for Q1 2021

drop_locn(): Drop the name of the 'location' column from a vector of names

ensure_cfg_param_types(): Ensure parameters are of the expected type

ensure_sys_env_vars(): Ensure the presence of required system environment variables

ensure_valid_env(): Check the validity of a specified 'environment' string

ensure_valid_phase(): Check the validity of a specified 'phase' string

env_should_run_hl_data_test(): Check whether to run a particular high-level data test

escape_txt(): Escape special characters in the given string

generate_cfg_template(): Create a config template containing default values

get_area_id_list(): Get a list of unique MSOA area id's, possibly subsetted

get_cfg(): Get a configuration to use for a run.

get_cfg_keys(): Recursively list all keys in a config

get_cfg_pkg_id(): Get the package identifier for creating the user config path

get_cfg_template_keys(): Retrieve a character vector of expected config keys

get_cfg_template_name(): Retrieve the config template file name

get_cfg_template_path(): Retrieve the config template path

get_cfg_val(): Get a config value from the config

get_cfg_val_msoa(): Get the MSOA value from the config

get_dat_path(): Get a path value from the configuration

get_grouping_vars(): Get grouping variables for the time use survey data

get_invalid_cfg_keys(): Retrieve any invalid keys from a config

get_most_popular_locn(): Get most popular location for each activity

get_path_components(): Get path components from a path specification

get_pkg_cfg_dir(): Get the package config directory

get_pop_dat(): Get the wrangled population data

get_req_sys_env_vars(): Retrieve names of the required system environment variables

get_root(): Get the root path for an environment

get_stratified_samp(): Create a small stratified sample from the given data

get_test_cfg(): Test helper to create a test config

get_test_cfg_exp_keys(): Test helper to return expected keys for the test config

get_tus_dat(): Get the wrangled time use survey data

get_user_cfg_dir(): Retrieve the user-specific config dir

get_user_cfg_name(): Retrieve the user-specific config file name

get_user_cfg_path(): Retrieve the config file path

`%notin%`: Establish whether particular values exist in a vector.

impute_missing(): Impute missing location data

impute_tus_dat(): Impute missing tus data

is_int_val(): Tests if a value is an integer.

is_r_cmd_check(): Check if R CMD CHECK is currently running

is_strict_vec(): Check if an object is a vector

local_mk_dir(): Test helper to create a temporary directory

local_sys_env_vars(): Test helper to temporarily set sys env vars

local_write_cfg(): Test helper to write a test config to file

parse_steps_to_run(): Parse which steps to run from a string

parse_string(): Parse a string into a number, NA or to remain as a string

path_from_components(): Construct a file system path from a vector of individual path components

plot_results_jul_2021(): Plot results for July 2021

plot_results_q1_2021(): Plot results for Q1 2021

process_activities(): Process Activities data

process_exposures_jul_2021(): Process Exposures data for July 2021

process_exposures_q1_2021(): Process Exposures data for Q1 2021

read_user_cfg(): Read the YAML config file into a named list

recurse_nested(): Recursively apply a function to each element of a nested list

run_data_prep_pm25_cams(): Process the pm25 cams data

run_data_prep_pm25_emep(): Process the PM25 EMEP data

run_data_prep_pm25_gm(): Process the PM25 GM data

run_data_prep_population(): Process the Population data

run_data_prep_study_region(): Process the Study Region data

run_data_prep_tus(): Process the Time Use Survey data

run_workflow(): Run the steps in the data prep, analysis and visualisation workflow pipeline

show_workflow_banner(): Print a banner to the console ahead of running a step in the workflow

skip_if_r_cmd_check_or_not_configured(): Skip a test under certain conditions

validate_cfg(): Validate a config

write_cfg_template(): Write the configuration template to file

write_user_cfg(): Write the user-specific config to file