Offline Environmental, Social and Governance Calculations

[Up] [Top]

Documentation for package ‘esgcalc’ version 0.2.0

Help Pages

esgcalc-package Offline Environmental, Social and Governance Calculations
aggregate_ghg_inventory Aggregate the declared scopes; market/location alternatives are never added
aggregate_issuer_positions Aggregate position values while requiring consistent duplicated issuer attributes
aggregate_pai_observations Mean of complete quarter-end observations, or explicitly selected additional observations
aggregate_pai_portfolio Calculate selected PAI components on one unchanged portfolio universe
allocate_multi_objective_contributions Allocate disjoint slices once in total; each slice may contribute to multiple goals
apply_rating_limits Apply most restrictive triggered cap; unknown required findings suppress the score
board_metrics Female representation uses all board members, including declared other/unknown gender
calculate_pai_indicator Calculate an enumerated Table 1 component; averaging conventions must be explicitly selected
check_quantitative_criterion Compute a selected clause from the edition-pinned numerical criterion catalog
combine_taxonomy_assessments Combine explicitly sourced assessments for six goals; never infer missing evidence
convert_currency Use explicit target-currency units per one source-currency unit; never fetch or invert
diversity_metrics Compute disjoint category shares including an explicit unknown category where needed
emissions_from_activity Multiply explicit activity quantities by sourced factors, output tonnes CO2e
energy_metrics Separate consumption/production and compute high-impact-sector revenue intensity
esgcalc Offline Environmental, Social and Governance Calculations
esgcalc-contracts Structured input schemas and numerical method contracts
esgcalc-resources Versioned offline catalogs and fictional example data
esg_context Declare an explicit calculation context
explain_rating Return stored rating contributions and reasons, without inventing narrative conclusions
export_resources Export selected resources to an explicit local directory; never overwrite existing files
financed_emissions Declared listed-equity/listed-company-bond attribution using positive EVIC and sourced emissions
ghg_intensity Divide tonnes CO2e by an explicitly named positive physical/economic basis
health_safety_metrics Accident frequency, separately classified fatalities, days lost and coverage
list_resources List packaged resource names and checksums, without any remote registry
load_local_data Read UTF-8 JSON or CSV; CSV fields stay strings, with no guessed units or types
load_profile Return an explicitly requested profile; never infer legal applicability
load_reference_data Read and integrity-check a packaged JSON reference resource
metric_change Calculate change only on a declared comparable boundary/method; negative bases have no relative rate
normalize_indicator Interpolate an explicit model scale; reject incompatible units and out-of-domain inputs
overall_rating Combine E/S/G pillar records, check coverage, then apply caps and class thresholds
pay_gap Unadjusted pay gap (male minus female)/male, in percentage points; signed
pillar_scores Weight normalized indicator scores; report coverage separately and enforce minima
portfolio_concentration Herfindahl index and largest group weight for nonnegative exposures
portfolio_coverage Amount-weighted nonmissing field coverage with numerator/denominator retained
portfolio_exposure Known positive exposure and unknown share; incomplete data do not become false
portfolio_rating_summary Value-weight compatible company scores; report classes and unrated exposure separately
position_weights Long-only weights over the entire declared portfolio; no missing-position deletion
print.esg_result Print a structured calculation result
rate_company Rate dated sourced observations with coverage, provenance, contributions and binding caps
rating_sensitivity Recalculate explicit indicator-weight scenarios; preserve original model and observations
reconcile_kpi_allocations Reconcile disjoint allocation fractions against original amount IDs
taxonomy_capex Compute CapEx KPI with accounting exclusions, plan and individual-measure routes
taxonomy_opex Compute OpEx KPI, excluding capitalised/double-counted expenditure
taxonomy_turnover Compute nonfinancial turnover KPI from net-revenue rows and explicit assessments
validate_activity_assessment Validate distinct activities and their assessment inputs without classifying NACE codes
validate_governance_findings Check provenance/status of structured findings, without investigating their truth
validate_inputs Validate explicit nested table schemas, types, enums, units, bounds and unique IDs
validate_pai_inputs Check an indicator's declared universe, consistent issuer data and required typed fields
validate_rating_model Validate bounded piecewise scales, complete pillars, weights, classes and caps
waste_resource_metrics Separate waste destinations/hazardous totals and secondary material input shares
water_metrics Common-boundary consumption, risk-area consumption, storage and revenue intensity
workforce_metrics Aggregate disjoint workforce groups in headcount and FTE separately