Generates a tidy dataset representing user-level electricity generation. The simulation reflects renewable generation that displaces fossil baseline electricity use and produces monitoring period metadata suitable for downstream aggregation helpers.

simulate_ams_ia_dataset(
  n_users = 20,
  n_periods = 12,
  start_year = 2023,
  start_month = 1,
  mean_generation_kwh = 15000,
  sd_generation_kwh = 2000,
  grid_emission_factor = 0.75
)

Arguments

n_users

Number of end users to simulate.

n_periods

Number of monitoring periods (default monthly observations across a year).

start_year

Calendar year assigned to the first monitoring period.

start_month

Calendar month (1-12) assigned to the first monitoring period.

mean_generation_kwh

Mean annual electricity generation per user in kWh.

sd_generation_kwh

Standard deviation of annual electricity generation.

grid_emission_factor

Grid emission factor in tCO2e/kWh used for simulated emissions.

Value

A tibble containing simulated user identifiers, monitoring period metadata, generation, and emissions.

Examples

simulate_ams_ia_dataset(n_users = 5)
#> # A tibble: 60 × 13
#>    user_id monitoring_period  year month   day monitoring_date monitoring_label
#>    <chr>               <int> <dbl> <dbl> <int> <date>          <chr>           
#>  1 user_1                  1  2023     1    23 2023-01-23      2023-01         
#>  2 user_1                  2  2023     2    11 2023-02-11      2023-02         
#>  3 user_1                  3  2023     3    11 2023-03-11      2023-03         
#>  4 user_1                  4  2023     4     5 2023-04-05      2023-04         
#>  5 user_1                  5  2023     5    21 2023-05-21      2023-05         
#>  6 user_1                  6  2023     6    12 2023-06-12      2023-06         
#>  7 user_1                  7  2023     7     2 2023-07-02      2023-07         
#>  8 user_1                  8  2023     8     6 2023-08-06      2023-08         
#>  9 user_1                  9  2023     9     4 2023-09-04      2023-09         
#> 10 user_1                 10  2023    10    16 2023-10-16      2023-10         
#> # ℹ 50 more rows
#> # ℹ 6 more variables: generation_kwh <dbl>, grid_emission_factor <dbl>,
#> #   baseline_generation_kwh <dbl>, baseline_emissions_tco2e <dbl>,
#> #   project_emissions_tco2e <dbl>, emission_reductions_tco2e <dbl>