# Interactive 'shiny' GUI for the 'earth' Package

## Documentation for package ‘earthUI’ version 0.8.0

- DESCRIPTION file.
- User guides, package vignettes and other documentation.
- Package NEWS.

## Help Pages

auto_export_for_mgcv | Export an earthUI result as RDS for consumption by mgcvUI
build_allowed_function | Build an allowed function for earth()
build_allowed_matrix | Build an allowed interaction matrix
build_sales_grid | Build a Sales Comparison Grid Excel workbook
city_abbreviation | Generate a city path code from a full name
compute_intermediate_output | Compute intermediate output data frame
compute_rca_adjustments | Compute RCA (Residual Comparable Adjustment) output for an appraisal
compute_sale_age | Compute sale age in integer days
convert_quarto_file | Convert a Quarto source file to one or more output formats
country_choices | List all countries with shipped admin schemas
country_schema | Get the admin-level schema for a country
default_regproj_root | Default regProj root for the current OS
detect_categoricals | Detect likely categorical variables in a data frame
detect_types | Detect column types in a data frame
earthui_prefs_path | Path to the per-user earthUI preferences file
earthui_prefs_read | Read user preferences (returns empty list if file missing)
earthui_prefs_write | Write user preferences (atomic; creates the config dir if needed)
export_settings | Export saved earthUI settings for one file+purpose to a JSON file
fit_earth | Fit an earth model
format_anova | Format ANOVA decomposition
format_model_equation | Format earth model as LaTeX equation
format_summary | Format earth model summary
format_variable_importance | Format variable importance
generate_quarto_report | Generate a Quarto report source bundle (without rendering)
get_project_settings | Get model settings for a project
import_data | Import data from CSV or Excel files
is_project_dir | Test whether a path is a regProj project leaf folder
launch | Launch the earthUI Shiny application
list_g_functions | List g-function groups from a fitted earth model
os_detect | Detect the current operating system as a regProj segment
plot_actual_vs_predicted | Plot actual vs predicted values
plot_contribution | Plot variable contribution
plot_correlation_matrix | Plot correlation matrix
plot_g_contour | Plot g-function as a static contour (for reports)
plot_g_function | Plot g-function contribution
plot_g_persp | Plot g-function as a static 3D perspective (for reports)
plot_partial_dependence | Plot partial dependence
plot_qq | Plot Q-Q plot of residuals
plot_residuals | Plot residual diagnostics
plot_variable_importance | Plot variable importance
prepare_report_assets | Prepare report assets
regproj_flat_segment | Encode the flat regProj segment from components
regproj_geo_db_connect | Open (and initialize if needed) the regProj geo database
regproj_geo_db_path | Path to the regProj geo SQLite database
regproj_index_get | Get a code for a full name within a scope
regproj_index_path | Path to the central regProj name-to-code index (legacy)
regproj_index_put | Set a name-to-code mapping in the geo SQLite DB
regproj_index_read | Read the central regProj index from the geo SQLite DB
regproj_index_write | Deprecated. The geo data is now in SQLite; this is a no-op kept for backward compatibility.
regproj_in_files | List input files in an active project's in/ folder
regproj_last_file | Last-used input file marker (per project)
regproj_last_file_get | Last-used input file marker (per project)
regproj_last_file_path | Last-used input file marker (per project)
regproj_last_file_set | Last-used input file marker (per project)
regproj_list_projects | List all projects under a regProj root
regproj_parse_flat | Decode a flat regProj segment back into components
regproj_path | Build a regProj-canonical path
regproj_projects_db_connect | Open (and initialize if needed) the regProj projects database
regproj_projects_db_path | Path to the regProj projects SQLite database
regproj_reference | Load the shipped regProj reference data
render_report | Render an earth model report
select_sales_grid_comps | Select comparable sales for the Sales Comparison Grid
set_project_settings | Set model settings for a project
validate_types | Validate declared column types against actual data
write_earth_output | Write an earth model summary to a text file
write_fit_log | Write an earthUI fitting log to a text file