Automated Soil Profile Classification per WRB 2022, 'SiBCS' 5
and USDA Soil Taxonomy 13
![[R logo]](figures/logo.png)
![[Up]](../../../doc/html/left.jpg)
![[Top]](../../../doc/html/up.jpg)
Documentation for package ‘soilKey’ version 0.9.155
- DESCRIPTION file
- User guides, package vignettes and other documentation
- Code demos. Use demo() to run them.
- Package NEWS
- Package README
Help Pages
A B C D E F G H I K L M N O P R S T U V W Y misc
-- A --
| abrupt_textural_difference | Abrupt textural difference (WRB 2022 Ch 3.2.1) |
| acrisol | Acrisol RSG diagnostic (WRB 2022) |
| aeolic_material | Aeolic material (WRB 2022 Ch 3.3.1) |
| albeluvic_glossae | Albeluvic glossae (WRB 2022 Ch 3.2.2) |
| albic | Albic horizon (WRB 2022) |
| alisol | Alisol RSG diagnostic (WRB 2022) |
| andic_properties | Andic properties (WRB 2022) |
| andosol | Andosol RSG gate (WRB 2022 Ch 4, p 104) |
| annotate_wrb_from_usda | Annotate KSSL/NASIS pedons with a derived WRB Reference Soil Group |
| anthraquic | Anthraquic horizon (WRB 2022): puddled-rice / paddy plough layer. v0.3.3 detects via designation pattern 'Apl|Ap|Hh'. |
| anthric_horizons | Anthric horizons (WRB 2022) |
| apply_soilgrids_depth_prior | Fill missing horizon attributes from a SoilGrids depth prior |
| arenic_texture | Arenic texture (WRB 2022) |
| argic | Argic horizon (WRB 2022) |
| argic_aqp | Argic / argillic horizon via aqp::getArgillicBounds() |
| argic_with_strong_clay_films | Test whether a pedon's argic horizon has strong clay films |
| argillic_clay_films_test | Test for clay-illuviation evidence (KST 13ed Ch 3 p 4) |
| artefacts | Artefacts (WRB 2022 Ch 3.3.2) |
| as_aqp | Convert one or more PedonRecord objects to an aqp SoilProfileCollection |
| attach_lucas_spectra | Attach LUCAS 2018 Vis-NIR spectra to a list of PedonRecord objects |
| audit_argic_strong_films | Audit the strong-clay-films exclusion across a list of pedons |
| auto_set_proj_env | Auto-detect PROJ_LIB and GDAL_DATA directories |
| available_esdb_attributes | List ESDB Raster Library attributes available at a given root |
-- B --
| batch_robustness | Batch robustness across many pedons |
| benchmark_afsp | Benchmark soilKey WRB predictions against AfSP ground truth |
| benchmark_bdsolos | Benchmark soilKey classifiers against BDsolos national reference labels |
| benchmark_lucas_2018 | Run the LUCAS Soil 2018 / ESDB WRB benchmark |
| benchmark_performance | Run the soilKey performance benchmark |
| benchmark_redape | Benchmark soilKey SiBCS predictions against the Redape gold standard |
| benchmark_run_classification | Run a benchmark across one of the loaded pedon lists |
| benchmark_spectral_fill | Benchmark the accuracy lift of spectral gap-fill (ON vs OFF), k-fold |
| benchmark_unified | Unified cross-dataset benchmark across SiBCS / WRB / USDA |
| benchmark_wrb_vs_usda | Benchmark soilKey WRB predictions against a USDA-derived ground truth |
| build_taxon_profiles | Build per-taxon mean depth profiles for predicted-taxon gap-fill |
| B_espodico | Horizonte B espodico (SiBCS Cap 2, p 62-65; v0.7) |
| B_incipiente | Horizonte B incipiente (SiBCS Cap 2, p 59-61; v0.7) |
| B_latossolico | Horizonte B latossolico (SiBCS Cap 2, p 57-59; v0.7 strict) |
| B_nitico | Horizonte B nitico (SiBCS Cap 2, p 61-62; v0.7) |
| B_planico | Horizonte B planico (SiBCS Cap 2, p 65-66; v0.7) |
| B_textural | Horizonte B textural (SiBCS Cap 2, p 54-57; v0.7 strict) |
-- C --
| calcaric_material | Calcaric material (WRB 2022 Ch 3.3.3): \>= 2% CaCO3 throughout the fine earth, primary carbonates from the parent material. |
| calcic | Calcic horizon (WRB 2022) |
| cambic | Cambic horizon (WRB 2022) |
| cambic_aqp | Cambic horizon via aqp::getCambicBounds() |
| canonicalise_kst13ed_gg | Canonicalise a USDA Great Group label to a KST 13ed-compatible key |
| canonical_reference | Load a canonical reference dataset from soilKey or SoilTaxonomy |
| cerosidade | Cerosidade quantitativa (SiBCS Cap 13, p 207; Cap 1) |
| chernic | Chernic horizon (WRB 2022): the cherozemic-style mollic with very high biological activity (worm holes, casts, coprolites). v0.3.3: delegates to mollic + worm_holes_pct >= 50 (proxy for "biological homogenization"). |
| chernozem | Chernozem RSG diagnostic (WRB 2022) |
| chernozem_strict | Chernozem RSG gate (strengthened, WRB 2022 Ch 4, p 111) |
| claric_material | Claric material (WRB 2022 Ch 3.3.4): light-coloured fine earth with Munsell criteria. |
| ClassificationResult | ClassificationResult: structured outcome of running a key |
| classification_robustness | Robustness of classification under input perturbation |
| classify_all | Classify a pedon across all three taxonomic systems |
| classify_by_spectral_neighbours | Classify a soil by spectral similarity to OSSL reference profiles |
| classify_from_documents | Build a fully-classified 'PedonRecord' from documents in one call |
| classify_from_photos | Classify a soil profile from field photographs alone |
| classify_sibcs | Classifica um pedon segundo o SiBCS 5a edicao (1o + 2o + 3o + 4o niveis) |
| classify_sibcs_familia | Classifica um perfil no 5o nivel categorico do SiBCS (Familia) |
| classify_usda | Classify a pedon under USDA Soil Taxonomy (13th edition) |
| classify_usda_family | Classify the USDA family (5th level) of a pedon |
| classify_via_smartsolos_api | Classify a PedonRecord via Embrapa's SmartSolosExpert REST API |
| classify_with_engine_heuristic | Classify a pedon with the engine chosen by 'pick_engine()' |
| classify_with_uncertainty | Posterior distribution over classification outcomes |
| classify_wrb2022 | Classify a pedon under WRB 2022 |
| clear_kst13_cache | Clear the in-memory KST13 cache |
| clear_ossl_cache | Clear the soilKey OSSL cache |
| combine_priors | Combine multiple spatial priors via weighted geometric mean |
| compare_engines | Side-by-side comparison of soilKey vs aqp diagnostic engines |
| compare_smartsolos | Cross-validate the local SiBCS classifier against the SmartSolosExpert API |
| compute_ki | Ki (silica:alumina molar) - SiBCS Cap 1, p 32 |
| compute_kr | Kr (silica:sesquioxidos molar) - SiBCS Cap 1, p 32 |
| compute_per_attribute_evidence_grade | Per-attribute provenance-aware evidence grade |
| continuous_rock | Continuous rock (WRB 2022 Ch 3.2.5) |
| coverage_report | Honest taxonomic-completeness report |
| cryic_conditions | Cryic conditions (WRB 2022) |
-- D --
| DiagnosticResult | DiagnosticResult: structured outcome of a diagnostic test |
| distrofico | Solo distrofico (SiBCS Cap 1, p 30) |
| dolomitic_material | Dolomitic material (WRB 2022 Ch 3.3.5): \>= 2% Mg-rich carbonate, CaCO3/MgCO3 < 1.5. v0.3.3: detects via designation pattern 'kdo|do|magn' as proxy when ratio data missing. |
| download_bdsolos | Download the BDsolos consulta-publica CSV (experimental, requires chromote) |
| download_extdata_cache | Download one or more soilKey lazy-fetch caches from GitHub Release |
| download_ossl_subset | Download an OSSL subset and return an 'ossl_library' artefact |
| download_ossl_subset_with_labels | Download an OSSL subset and attach WRB / SiBCS / USDA labels |
| download_redape_dataset | Download the curated Redape GeoTab dataset (Vaz et al 2023) |
| duric_horizon | Duric horizon (WRB 2022) |
| duripa | Duripa (SiBCS Cap 2, p 74; v0.7) |
-- E --
| ensure_horizon_schema | Coerce a horizons-like data.frame to the canonical schema |
| eutrofico | Solo eutrofico (SiBCS Cap 1, p 30) |
| evaluate_rsg_tests | Evaluate the test block of a single RSG |
| extract_horizons_from_pdf | Extract horizons from a soil description PDF |
| extract_munsell_from_photo | Extract Munsell color from a profile photo |
| extract_site_from_fieldsheet | Extract site metadata from a field-sheet image |
-- F --
| familia_mineralogia_argila_geral | Familia: mineralogia da fracao argila (geral, nao-Latossolos) |
| FamilyAttribute | Classe S4-like para atributos de Familia (5o nivel SiBCS) |
| febr_index_munsell | Curated index of FEBR datasets that carry Munsell colors |
| ferralic | Ferralic horizon (WRB 2022) |
| ferralsol | Ferralsol RSG gate (WRB 2022 Ch 4, p 110) |
| ferric | Ferric horizon (WRB 2022) |
| fibrico | Material organico fibrico (SiBCS Cap 14) |
| fill_from_spectra | Fill missing soil attributes from spectra via OSSL |
| fill_munsell_from_spectra | Fill missing Munsell colors on a PedonRecord from Vis-NIR spectra |
| fluvic_material | Fluvic material (WRB 2022) |
| format_wrb_name | Format a WRB 2022 soil name with qualifiers |
| fragic | Fragic horizon (WRB 2022): a high-bulk-density horizon with restricted rooting. v0.3.3: detects via bulk_density_g_cm3 >= 1.65 AND structure grade massive/very firm OR designation pattern 'x'/'Bx'. |
| fragipa | Fragipa (SiBCS Cap 2, p 73-74; v0.7) |
| from_aqp | Convert an aqp SoilProfileCollection back to a list of PedonRecord |
-- G --
| gapfill_by_predicted_taxon | Fill missing horizon attributes from the predicted taxon's mean profile |
| gapfill_derive_horizon | Fill horizon attributes derivable BY DEFINITION from the same horizon |
| gapfill_within_pedon | Fill interior missing horizon attributes by within-pedon depth interpolation |
| get_perturbation_scale | Monte-Carlo perturbation scale for an evidence grade |
| gleyic_properties | Gleyic properties (WRB 2022) |
| gleysol | Gleysol RSG gate (WRB 2022 Ch 4, p 103) |
| grapes-or-or-grapes | Default-value-for-NULL operator |
| GSM_DEPTHS | Default GlobalSoilMap depth intervals (cm) |
| gypsic | Gypsic horizon (WRB 2022) |
| gypsiric_material | Gypsiric material (WRB 2022 Ch 3.3.7): \>= 5% gypsum that is primary (not secondary). Without a "secondary fraction" schema column, v0.3.3 treats any layer with caso4_pct >= 5 as gypsiric unless it explicitly carries gypsic-horizon designation. |
-- H --
| harmonize_to_gsm | Harmonise pedons to GlobalSoilMap depth intervals |
| hemico | Material organico hemico (SiBCS Cap 14) |
| histic_horizon | Histic horizon (WRB 2022) |
| horizon_column_spec | Canonical horizon column specification |
| hortic | Hortic horizon (WRB 2022): garden / kitchen-midden topsoil. Diagnostic criteria: thickness \>= 20 cm, dark colour (mollic-like), high P (Mehlich-3 P >= 100 mg/kg or P2O5_1pct_citric >= 175 mg/kg), high SOC. |
| hydragric | Hydragric horizon (WRB 2022): subsoil hydric horizon under anthraquic. v0.3.3 detects via designation pattern 'Bg|Brg' immediately below an anthraquic-like topsoil. |
| hypersulfidic_material | Hypersulfidic material (WRB 2022 Ch 3.3.8): \>= 0.01% inorganic sulfidic S, pH \>= 4, capable of severe acidification on aerobic incubation. |
| hyposulfidic_material | Hyposulfidic material (WRB 2022 Ch 3.3.9): same inorganic sulfidic S and field pH as hypersulfidic but does NOT consist of hypersulfidic (criterion 3 - does not acidify to pH < 4 on aerobic incubation, usually self-neutralised by carbonate). Reachable from v0.9.128: when 'incubation_ph' is measured, a sulfidic + pH>=4 layer that stays >= 4 on incubation is the set-complement of 'hypersulfidic_material' and is reported here. Without an incubation pH the two cannot be told apart, so this returns empty (the layer is reported as potential hypersulfidic instead). |
-- I --
| inspect_bdsolos_csv | Diagnostic inspection of a BDsolos CSV before loading |
| irragric | Irragric horizon (WRB 2022): topsoil thickened by irrigation deposits. v0.3.3: thickness >= 20 cm + sediment-derived structure proxied via designation 'Apk|Apg|Au'. |
-- K --
| kastanozem | Kastanozem RSG diagnostic (WRB 2022) |
| kastanozem_strict | Kastanozem RSG gate (strengthened, WRB 2022 Ch 4, p 112) |
| kst13_canonical | Keys to Soil Taxonomy 13th edition canonical reference |
| kst13_codes | Load the canonical KST 13ed code -> taxon-name lookup table |
| kst13_criteria | Load the canonical KST 13ed criteria for a single taxon code |
-- L --
| leptic_features | Leptic features (WRB 2022) |
| limnic_material | Limnic material (WRB 2022 Ch 3.3.10): subaquatic deposits (coprogenous earth, diatomaceous earth, marl, gyttja). v0.3.3: detects via 'rock_origin %in% c("lacustrine", "marine")' or designation pattern. |
| limonic | Limonic horizon (WRB 2022 Ch 3.1) |
| lithic_discontinuity | Lithic discontinuity (WRB 2022 Ch 3.2.7) |
| lixisol | Lixisol RSG diagnostic (WRB 2022) |
| load_afsp_pedons | Load Africa Soil Profiles (AfSP) v1.2 as PedonRecord objects |
| load_afsp_sample | Load the bundled AfSP stratified sample (v0.9.77) |
| load_bdsolos_csv | Load a BDsolos CSV export as a list of PedonRecord objects |
| load_embrapa_pedons | Load Embrapa dadosolos pedons with reference SiBCS classification |
| load_febr_pedons | Load the Embrapa FEBR superconjunto into a list of PedonRecords |
| load_kssl_nasis_sample | Load the bundled KSSL + NASIS morphological-enriched sample (v0.9.75) |
| load_kssl_pedons | Load NCSS / KSSL pedons with reference USDA Soil Taxonomy classification |
| load_kssl_pedons_gpkg | Load KSSL / NCSS pedons from the ncss_labdata GeoPackage |
| load_kssl_pedons_with_nasis | Load KSSL pedons enriched with NASIS morphology |
| load_kssl_sample | Load the bundled KSSL/NCSS lab-data sample (v0.9.74) |
| load_lucas_pedons | Load EU-LUCAS / ESDB pedons with reference WRB classification |
| load_lucas_soil_2018 | Load the LUCAS Soil 2018 Topsoil release as a list of PedonRecord objects |
| load_ossl_models | Save / load trained OSSL-backed PLSR models |
| load_redape_pedons | Load curated soil profiles from the Embrapa Redape GeoTab dataset |
| load_rules | Load a soilKey rule set (YAML) |
| load_wosis_sample | Load the bundled WoSIS South-America sample |
| load_wosis_stratified_sample | Load the bundled WoSIS stratified RSG-balanced sample (v0.9.73) |
| lookup_esdb | Look up an ESDB raster value at WGS84 coordinates |
| lookup_mapbiomas_solos | Look up a MapBiomas Solos raster value at WGS84 coordinates |
| lookup_soilgrids | Look up a SoilGrids 250m soil property at WGS84 coordinates |
| luvisol | Luvisol RSG diagnostic (WRB 2022) |
-- M --
| make_acrisol_canonical | Build the canonical Acrisol fixture |
| make_alisol_canonical | Build the canonical Alisol fixture |
| make_andosol_canonical | Build the canonical Andosol fixture |
| make_anthrosol_canonical | Build the canonical Anthrosol fixture |
| make_arenosol_canonical | Build the canonical Arenosol fixture |
| make_argissolo_canonical | Perfil canonico de Argissolo (SiBCS 5a ed., Cap 5) |
| make_calcisol_canonical | Build the canonical Calcisol fixture |
| make_cambisol_canonical | Build the canonical Cambisol fixture |
| make_cambissolo_canonical | Perfil canonico de Cambissolo (SiBCS 5a ed., Cap 6) |
| make_chernossolo_canonical | Perfil canonico de Chernossolo (SiBCS 5a ed., Cap 7) |
| make_chernozem_canonical | Build the canonical Chernozem fixture |
| make_cryosol_canonical | Build the canonical Cryosol fixture |
| make_durisol_canonical | Build the canonical Durisol fixture |
| make_empty_horizons | Build an empty horizons data.table with the canonical schema |
| make_espodossolo_canonical | Perfil canonico de Espodossolo (SiBCS 5a ed., Cap 8) |
| make_ferralsol_canonical | Build the canonical Ferralsol fixture |
| make_fluvisol_canonical | Build the canonical Fluvisol fixture |
| make_gleissolo_canonical | Perfil canonico de Gleissolo (SiBCS 5a ed., Cap 9) |
| make_gleysol_canonical | Build the canonical Gleysol fixture |
| make_gypsisol_canonical | Build the canonical Gypsisol fixture |
| make_histosol_canonical | Build the canonical Histosol fixture |
| make_kastanozem_canonical | Build the canonical Kastanozem fixture |
| make_latossolo_canonical | Perfil canonico de Latossolo (SiBCS 5a ed., Cap 10) |
| make_leptosol_canonical | Build the canonical Leptosol fixture |
| make_lixisol_canonical | Build the canonical Lixisol fixture |
| make_luvisol_canonical | Build the canonical Luvisol fixture |
| make_luvissolo_canonical | Perfil canonico de Luvissolo (SiBCS 5a ed., Cap 11) |
| make_neossolo_canonical | Perfil canonico de Neossolo Litolico (SiBCS 5a ed., Cap 12) |
| make_nitisol_canonical | Build the canonical Nitisol fixture |
| make_nitossolo_canonical | Perfil canonico de Nitossolo Vermelho (SiBCS 5a ed., Cap 13) |
| make_organossolo_canonical | Perfil canonico de Organossolo (SiBCS 5a ed., Cap 14) |
| make_phaeozem_canonical | Build the canonical Phaeozem fixture |
| make_planosol_canonical | Build the canonical Planosol fixture |
| make_planossolo_canonical | Perfil canonico de Planossolo (SiBCS 5a ed., Cap 15) |
| make_plinthosol_canonical | Build the canonical Plinthosol fixture |
| make_plintossolo_canonical | Perfil canonico de Plintossolo (SiBCS 5a ed., Cap 16) |
| make_podzol_canonical | Build the canonical Podzol fixture |
| make_retisol_canonical | Build the canonical Retisol fixture |
| make_solonchak_canonical | Build the canonical Solonchak fixture |
| make_solonetz_canonical | Build the canonical Solonetz fixture |
| make_stagnosol_canonical | Build the canonical Stagnosol fixture |
| make_synthetic_pedon_with_spectra | Build a synthetic PedonRecord with attached spectra (testing aid) |
| make_technosol_canonical | Build the canonical Technosol fixture |
| make_umbrisol_canonical | Build the canonical Umbrisol fixture |
| make_vertisol_canonical | Build the canonical Vertisol fixture |
| make_vertissolo_canonical | Perfil canonico de Vertissolo (SiBCS 5a ed., Cap 17) |
| mineral_material | Mineral material (WRB 2022 Ch 3.3.11): < 20% SOC AND < 35% volume artefacts containing >= 20% organic carbon. The complement of organic_material / organotechnic_material. |
| mollic | Mollic horizon (WRB 2022) |
| mudanca_textural_abrupta | Mudanca textural abrupta (SiBCS Cap 1, p 30-31) |
| mulmic_material | Mulmic material (WRB 2022 Ch 3.3.12): mineral material developed from organic material; \>= 8% SOC, with low BD, structural / chroma criteria. |
-- N --
| natric_horizon | Natric horizon (WRB 2022) |
| nitic_horizon | Nitic horizon (WRB 2022) |
| normalise_febr_sibcs | Canonicalise FEBR SiBCS names to match soilKey rule outputs. |
| normalise_febr_usda | Normalise FEBR USDA taxon strings to USDA Soil Taxonomy Order |
| normalise_febr_wrb | Normalise FEBR WRB taxon strings to RSG-only |
| normalise_kssl_subgroup | Normalise KSSL USDA subgroup labels for benchmark comparison |
-- O --
| ollama_is_running | Is the local Ollama HTTP API reachable? |
| organic_material | Organic material (WRB 2022 Ch 3.3.13): \>= 20% SOC + recognisability criteria. v0.3.3: SOC threshold only. |
| organotechnic_material | Organotechnic material (WRB 2022 Ch 3.3.14): \>= 35% volume of artefacts that themselves contain \>= 20% organic C. Soil itself has < 20% SOC. |
| ornithogenic_material | Ornithogenic material (WRB 2022 Ch 3.3.15): bird-influenced topsoil. Mehlich-3 P >= 750 mg/kg + designation pattern 'Aornit|Bornit'. |
| ossl_demo_sa | Synthetic OSSL South America demo subset |
| ossl_library_template | Canonical schema for an 'ossl_library' object |
| oxic_usda | Oxic horizon (USDA Soil Taxonomy) |
-- P --
| panpaic | Panpaic horizon (WRB 2022 Ch 3.1) |
| PedonRecord | PedonRecord: structured representation of a single pedon |
| pedons_from_spectral_table | Build PedonRecords with attached Vis-NIR/MIR spectra from a table |
| pedon_json_schema | JSON Schema for a soilKey PedonRecord |
| pedon_to_spc | Convert a soilKey PedonRecord to an aqp SoilProfileCollection |
| petrocalcic | Petrocalcic horizon (WRB 2022) |
| petroduric | Petroduric horizon (WRB 2022): cemented duric. |
| petrogypsic | Petrogypsic horizon (WRB 2022): cemented gypsic. |
| petroplinthic | Petroplinthic horizon (WRB 2022): cemented plinthic. |
| phaeozem | Phaeozem RSG diagnostic (WRB 2022) |
| pick_engine | Choose the best diagnostic engine for a single pedon |
| pick_engine_batch | Per-pedon batch engine recommendation |
| pisoplinthic | Pisoplinthic horizon (WRB 2022): pisolitic plinthic. v0.3.3 detects via designation pattern 'Bspl' / 'Bvpi' or via plinthite \>= 15% AND structure_type containing 'pisol'. |
| pi_to_confidence | Map a 95% prediction interval to a [0, 1] confidence score |
| plaggic | Plaggic horizon (WRB 2022): sod-derived topsoil >= 20 cm with low BD AND independent evidence of human input. |
| planic_features | Planic features (WRB 2022) |
| planosol | Planosol RSG gate (WRB 2022 Ch 4, p 107) |
| plinthic | Plinthic horizon (WRB 2022) |
| posterior_classify | Bayesian posterior classifier (optional) |
| predict.soilKey_pls_model | Predict from a soilKey_pls_model |
| predict_from_spectra | Predict soil properties from spectra |
| predict_lab_from_spectra | Predict CIE Lab from Vis-NIR reflectance spectra |
| predict_munsell_from_spectra | Predict Munsell hue / value / chroma from Vis-NIR reflectance spectra |
| predict_ossl_mbl | Memory-based learning prediction against the OSSL library |
| predict_ossl_plsr_local | Local PLSR prediction against the OSSL library |
| predict_ossl_pretrained | Pre-trained OSSL prediction |
| predict_xyz_from_spectra | Predict CIE XYZ tristimulus values from Vis-NIR reflectance spectra |
| preprocess_spectra | Pre-process Vis-NIR or MIR spectra |
| pretic | Pretic horizon (WRB 2022): "Amazonian Dark Earth" (terra preta de indio) horizon - thick anthropogenic surface with high P, SOC, and incorporated charcoal / pottery. |
| print.soilKey_pls_model | Print method for soilKey_pls_model |
| prior_consistency_check | Check consistency between a deterministic RSG assignment and a spatial prior |
| protocalcic_properties | Protocalcic properties (WRB 2022 Ch 3.2.8) |
| protogypsic_properties | Protogypsic properties (WRB 2022 Ch 3.2.9): visible secondary gypsum \>= 1% but below the gypsic gate. |
| protovertic | Protovertic horizon (WRB 2022 Ch 3.1) |
-- R --
| read_febr_pedons | Load FEBR datasets as a list of PedonRecord objects |
| read_spectral_library | Read a Vis-NIR / MIR reflectance + lab table into an OSSL-shaped library |
| reducing_conditions | Reducing conditions (WRB 2022 Ch 3.2.10) - per-pedon test wrapping 'test_reducing_conditions'. |
| report | Render a soilKey classification report |
| report_html | Render a soilKey classification report as self-contained HTML |
| report_pdf | Render a soilKey classification report as PDF |
| report_to_qgis | Export a classification result + pedon to a QGIS GeoPackage |
| resolve_wrb_qualifiers | Resolve WRB 2022 qualifiers for a Reference Soil Group |
| retic_properties | Retic properties (WRB 2022) |
| run_all_benchmarks | Run the full soilKey benchmark suite and (optionally) write a report |
| run_classify_app | Launch the soilKey interactive classification Shiny app |
| run_demo | Launch the soilKey Shiny demo (one-screen GUI) |
| run_sibcs_grande_grupo | Resolve o grande grupo (3o nivel) de um pedon classificado em uma subordem SiBCS |
| run_sibcs_key | Roda a chave SiBCS 5a edicao sobre um pedon |
| run_sibcs_subgrupo | Resolve o subgrupo (4o nivel) de um pedon classificado em um Grande Grupo SiBCS |
| run_sibcs_subordem | Resolve a subordem de um pedon ja classificado em uma ordem SiBCS |
| run_taxa_list | Iterate a flat taxa list and evaluate tests in canonical order |
| run_taxonomic_key | Run a taxonomic key (system-agnostic engine) |
| run_usda_great_group | Run the USDA Great Group key for a given Suborder |
| run_usda_key | Run the USDA Soil Taxonomy Order key over a pedon |
| run_usda_subgroup | Run the USDA Subgroup key for a given Great Group |
| run_usda_suborder | Run the USDA Suborder key for a given Order |
| run_wrb_key | Run the WRB 2022 key over a pedon |
-- S --
| salic | Salic horizon (WRB 2022) |
| saprico | Material organico saprico (SiBCS Cap 14) |
| save_ossl_models | Save / load trained OSSL-backed PLSR models |
| shrink_swell_cracks | Shrink-swell cracks (WRB 2022 Ch 3.2.12) - per-pedon test wrapping 'test_shrink_swell_cracks'. |
| sideralic_properties | Sideralic properties (WRB 2022 Ch 3.2.13) |
| soilgrids_usda_lut | SoilGrids -> USDA Soil Order lookup table (placeholder) |
| soilgrids_wrb_lut | SoilGrids -> WRB code lookup table |
| soil_classes_at_location | Likely soil classes at a geographic location (spatial classification aid) |
| soil_organic_carbon | Soil organic carbon (WRB 2022 Ch 3.3.16): organic C that does NOT belong to artefacts. v0.3.3: any layer with oc_pct >= 0.1 and artefacts_industrial_pct < 35. |
| solimovic_material | Solimovic material (WRB 2022 Ch 3.3.17): hetero genous mass-movement material on slopes / footslopes (formerly "colluvic"). v0.3.3: detects via 'rock_origin == "colluvial"' OR 'layer_origin == "solimovic"'. |
| sombric | Sombric horizon (WRB 2022): subsurface accumulation of humus that qualified neither as spodic nor as a true mollic-like horizon (low-base-saturation cool tropical highlands). v0.3.3 detects via designation pattern + OC criteria (BS < 50, OC > 0.6, depth > 25 cm). |
| spatial_prior | Spatial prior over RSGs (or Orders) at a pedon's location |
| spatial_prior_embrapa | Embrapa national soil-class spatial prior (Brazil only) |
| spatial_prior_soilgrids | SoilGrids spatial prior |
| spodic | Spodic horizon (WRB 2022) |
| stagnic_properties | Stagnic properties (WRB 2022) |
| st_features_canonical | USDA Soil Taxonomy diagnostic features canonical table |
| subgrupo_planossolo_espessos | Subgrupo "espessos" de Planossolos (B planico profundo, > 100 cm) |
| subgrupo_planossolo_mesicos | Subgrupo "mesicos" de Planossolos (B planico topo em [50, 100] cm) |
| subgrupo_plintossolo_endico_concrecionario | Subgrupo "endico" de Plintossolos Concrecionarios (topo de horizonte concrecionario >= 40 cm) |
| subgrupo_plintossolo_endico_litoplintico | Subgrupo "endico" de Plintossolos Litoplinticos (topo de horizonte litoplintico >= 40 cm) |
| subgrupo_plintossolo_espessos | Subgrupo "espessos" de Plintossolos (horizonte plintico topo > 100 cm) |
-- T --
| takyric_properties | Takyric properties (WRB 2022 Ch 3.2.15) - per-pedon test wrapping 'test_takyric_surface'. |
| technic_features | Technic features (WRB 2022) |
| technic_hard_material | Technic hard material (WRB 2022 Ch 3.3.18): consolidated human-made material (asphalt, concrete, worked stones). |
| tephric_material | Tephric material (WRB 2022 Ch 3.3.19): \>= 30% volcanic glass in 0.02-2 mm fraction AND no andic / vitric properties. |
| terric | Terric horizon (WRB 2022): topsoil thickened by long-term application of mineral material (sediment / sand additions). v0.3.3: thickness >= 20 cm + designation Au / Apc. |
| texture_class_from_pct | NRCS texture-class shorthand from clay / silt / sand percent |
| thionic | Thionic horizon (WRB 2022): post-oxidation acid sulfate horizon. Requires sulfidic_s_pct >= 0.01 AND pH(H2O) <= 4. |
| train_pls_from_ossl | Train pre-trained PLSR models from an OSSL library |
| tsitelic | Tsitelic horizon (WRB 2022 Ch 3.1) |
-- U --
| umbric_horizon | Umbric horizon (WRB 2022) |
| usda_to_wrb_rsg | USDA Soil Taxonomy <-> WRB Reference Soil Group correlation table |
-- V --
| validate_horizon_geometry | Validate horizon depth geometry |
| validate_pedon_json | Validate a PedonRecord against the JSON schema |
| vertic_horizon | Vertic horizon (WRB 2022 Ch 3.1) |
| vertic_properties | Vertic properties (WRB 2022) |
| vertisol | Vertisol RSG gate (WRB 2022 Ch 4, p 101) |
| vitric_properties | Vitric properties (WRB 2022 Ch 3.2.16) |
| vlm_pick_provider | Pick the best available VLM provider |
| vlm_provider | Construct a VLM provider chat object |
-- W --
| wrb06_code_to_rsg | WRB 2006 RSG code -> 2022 RSG name |
| wrb2022_canonical | WRB 2022 canonical reference (parsed IUSS Working Group WRB 2022) |
-- Y --
| yermic_properties | Yermic properties (WRB 2022 Ch 3.2.17) - per-pedon test wrapping 'test_yermic_surface'. |
-- misc --
| %||% | Default-value-for-NULL operator |