Print loaded run parameters

Print the run parameters currently loaded in the settings object. Use to display key configuration values for diagnostics and reproducibility.

Usage

print_params(settings_obj = NULL)

Arguments

settings_obj

list. Settings object. If NULL, uses global settings. Must include keys: dbname, schema, weight_version_name, project_name, data_root, code_root, conf_root, python_env, acs_dataset, pums_dataset, pums_year, acs_year.

Value

None. Prints to console.

Details

• Prints project, database, schema, ACS/PUMS years and datasets, directories, and environment.

• Accepts settings object or uses global settings if available.

• Errors if no settings object is found.

• No side effects except console output.

Settings

• dbname (direct): Database name. Default from settings.

• schema (direct): Database schema. Default from settings.

• weight_version_name (direct): Weight version name. Default from settings.

• project_name (direct): Project name. Default from settings.

• data_root (direct): Data directory. Default from settings.

• code_root (direct): Code directory. Default from settings.

• conf_root (direct): Config directory. Default from settings.

• python_env (direct): Python environment. Default from settings.

• acs_dataset (direct): ACS dataset name. Default from settings.

• pums_dataset (direct): PUMS dataset name. Default from settings.

• pums_year (direct): PUMS year. Default from settings.

• acs_year (direct): ACS year. Default from settings.

See also

• scripts/io/print_params.R

Other io utilities: clean_data_dict(), cut_and_label(), db_table_has_geometry(), fetch_acs(), fetch_all_hts_tables(), fetch_from_db(), fetch_hts_table(), fetch_pums(), fetch_study_region(), find_project_root(), fix_value_labels_on_load(), get_db_table_name(), pums_checksum(), read_from_db(), read_pums_codebook(), record_checksum(), sampled_latlon_to_bg()

Examples

## Not run:
print_params(settings)
#> Error: object 'settings' not found
## End(Not run)