Generate an ICMM Mining Principles report

Assesses a site against the ICMM Mining Principles, producing a board scorecard, a traffic-light assessment and data-driven recommendations. Traffic lights reclassify existing MineSDG KPI scores against configurable thresholds; recommendations are evaluated from the icmm_recommendation_rules dataset.

Usage

generate_icmm_report(site_data, site_id = NULL, years = NULL,
  registry = MineSDG::mining_kpi_registry, narratives = list(),
  entity_meta = list(), params = icmm_default_params(), output = NULL,
  format = c("html", "pdf", "docx", "xlsx"))

Arguments

site_data

A site data.frame or a minesdg_disclosure_bundle.

site_id, years, registry, narratives, entity_meta

Passed to compile_site_disclosures when site_data is a data.frame.

params

ICMM parameters from icmm_default_params.

output

Optional path; when supplied the report is rendered.

format

Output format used when output is supplied.

Value

A minesdg_report with extra elements $extras$scorecard, $extras$traffic_lights and $extras$recommendations.

Examples

rep <- generate_icmm_report(demo_mine_sites, site_id = "CU-ATAC",
                            years = 2023:2024)
rep$extras$traffic_lights[1:5, ]
#>                      kpi_id                   kpi_name sdg_goal  value
#>                      <char>                     <char>    <num>  <num>
#> 1:           tailings_ratio      Tailings-to-Ore Ratio       12  0.983
#> 2:     water_recycling_rate       Water Recycling Rate        6 40.830
#> 3:    female_employment_pct    Female Employment Share        5 21.100
#> 4:  land_rehabilitation_pct   Land Rehabilitation Rate       15 56.520
#> 5: community_investment_pct Community Investment Ratio        1  1.014
#>            unit score  light
#>          <char> <num> <char>
#> 1:      t/t ore   4.3    red
#> 2:            %  37.9    red
#> 3:            %  64.4  amber
#> 4:            %  66.5  amber
#> 5: % of revenue  66.5  amber
rep$extras$recommendations
#>      principle                     trigger
#>         <char>                      <char>
#> 1: Principle 6 water_recycling_rate is red
#> 2: Principle 6       tailings_ratio is red
#>                                                                                                        recommendation
#>                                                                                                                <char>
#> 1: Invest in water recirculation: thickened-tailings water recovery and process-water reuse to raise recycling rates.
#> 2:        Review tailings minimisation options (ore sorting, coarse particle recovery) and confirm GISTM conformance.
#>    priority
#>       <int>
#> 1:        2
#> 2:        2