Generate a GRI sustainability report

Builds a GRI report covering GRI 302 (Energy), 303 (Water and Effluents), 304 (Biodiversity), 305 (Emissions), 306 (Waste), 403 (Occupational Health and Safety) and 413 (Local Communities). All quantitative disclosures are resolved through the disclosure bundle; no calculation is performed in the reporting layer.

Usage

generate_gri_report(site_data, site_id = NULL, years = NULL,
  registry = MineSDG::mining_kpi_registry, narratives = list(),
  entity_meta = list(),
  standards = c(302, 303, 304, 305, 306, 403, 413), output = NULL,
  format = c("html", "pdf", "docx", "xlsx"))

Arguments

site_data

A site data.frame (see demo_mine_sites) or a prepared minesdg_disclosure_bundle.

site_id, years, registry, narratives, entity_meta

Passed to compile_site_disclosures when site_data is a data.frame.

standards

Integer vector of GRI topic standards to include; default all supported (302, 303, 304, 305, 306, 403, 413).

output

Optional path. When supplied the report is rendered to format at this location (see render_minesdg_report).

format

Output format used when output is supplied.

Value

A minesdg_report object (invisibly when output is supplied).

See also

render_minesdg_report, write_report_xlsx

Examples

rep <- generate_gri_report(demo_mine_sites, site_id = "CU-ATAC",
                           years = 2022:2024)
rep
#> == MineSDG GRI Report ==
#> Site: CU-ATAC | Reporting year: 2024 
#> Composite: 66.8 / 100 | Grade: C 
#> Disclosures: 25 | reported: 19 | narrative pending: 5 | mandatory coverage: 77.3% 
#> Render with render_minesdg_report(); export tables with write_report_xlsx().
#> Version: 0.4.0 | crosswalk: gri:2021+g11:2022/map-v1 
gri_content_index(rep)[1:5, ]
#>   disclosure_id                             disclosure_title             status
#> 1         302-1   Energy consumption within the organization           reported
#> 2        302-1b        Renewable share of energy consumption           reported
#> 3         302-3                             Energy intensity           reported
#> 4         303-1 Interactions with water as a shared resource narrative_required
#> 5         303-3                             Water withdrawal           reported
#>                     source              omission_reason
#> 1            raw:energy_gj                             
#> 2 raw:renewable_energy_pct                             
#> 3     kpi:energy_intensity                             
#> 4 narrative:nar_water_mgmt Narrative disclosure pending
#> 5  raw:water_withdrawal_m3