with_emissions_tracked: Track emissions for a single block of code

In CodeCarbonR: Track Energy Consumption and Carbon Emissions of R Code

Track emissions for a single block of code

Description

Track emissions for a single block of code

Usage

with_emissions_tracked(expr, country_iso_code = NULL, ...)

Arguments

expr	Code to run and measure.
country_iso_code	3-letter ISO code used to look up grid carbon intensity, e.g. "USA". Call list_carbon_tracker_countries() for the supported codes.
...	Passed to carbon_tracker().

Value

A carbon_emissions_result: ⁠$result⁠ holds the value of expr, ⁠$emissions⁠ holds the carbon_emissions object.

Examples

# Requires codecarbon to be installed (setup_carbon_tracker()); not run
# on CRAN's check machines, which don't have it.
if (carbon_tracker_ready()) {
  out <- with_emissions_tracked(
    Sys.sleep(1),
    country_iso_code = "USA",
    output_dir = tempdir()
  )
  print(out)
}

CodeCarbonR documentation built on Sept. 21, 2026, 5:08 p.m.