Package index • energyRt

Classes

Data structures of the key model components.

storage-class: An S4 class to represent storage type of technological process.

subsidy-class: An S4 class to represent a commodity subsidy

tax-class: An S4 class to represent a commodity tax

get_process_class(): Get class of processes

supply-class: An S4 class to represent a supply of a commodity

class-calendar: An S4 class to represent sub-annual time resolution structure.

class-commodity: An S4 class to represent a commodity

class-config: An S4 class to represent default model configuration.

class-constraint class-summand experimental: An S4 class to represent a custom constraint.

class-costs: An S4 class to add costs to objective function

class-demand: An S4 class to declare a demand in the model

class-export: An S4 class to represent commodity export to the rest of the world.

class-horizon: An S4 class to represent model/scenario planning horizon with intervals (year-steps)

class-import: An S4 class to represent commodity import from the rest of the world.

class-model: An S4 class to represent model

class-modInp: An S4 class to represent model input

class-modOut: An S4 class to store results of a solved scenario

class-parameter: An S4 class to specify the model set or parameter

class-repository: An S4 class to store the model objects.

class-scenario: An S4 class to represent scenario, an interpolated and/or solved model.

class-settings: An S4 class to represent scenario settings

class-technology: An S4 class to represent technology

class-trade: An S4 class to represent inter-regional trade

class-weather: S4 class to represent weather factors

Building a model

Functions to create model components.

newCalendar(): Generate a new calendar object from

newCommodity(): Create new commodity object

newConstraint() isConstraint() newConstraintS(): Create constraint object to add custom constraints to the model.

newCosts(): Create new costs object

newDemand() update(<demand>): Create new demand object

newExport(): Create new export object

newHorizon() update(<horizon>) setHorizon(<config>) update(<config>): Create a new object of class 'horizon'

newImport(): Create new export object

newModel() setHorizon(<model>) getHorizon(<model>): Create new model object

newRegistry() experimental: Create a new registry object.

newRepository(): A constructor for the repository class

newScenario(): Generate a new scenario object

newSub(): Create a new subsidy object

newSupply(): Constructor for supply object.

newTax(): Create a new tax object

newTrade(): Create new trade object

newWeather(): Create new weather object

newStorage(): Create new storage object

newTechnology() update(<technology>): Create a new "technology" object.

make_timetable(): Create timetable of time-slices from given structure as a list

make_scenario_dirname(): Make a name for a scenario directory

update(<export>) update(<weather>): Update export object

update(<supply>): Update supply object

update(<storage>) update(<trade>) update(<import>): Update trade object

update_parameter(): Update parameter in the scenario by adding data to it

add(<repository>) add(<model>): Add an object to the model's repository

convert(<character>) convert(<numeric>) add_to_convert(<character>,<character>,<numeric>): Convert units

Configuration and Settings

Model configuration and scenario settings

class-config: An S4 class to represent default model configuration.

class-settings: An S4 class to represent scenario settings

class-calendar: An S4 class to represent sub-annual time resolution structure.

newCalendar(): Generate a new calendar object from

class-horizon: An S4 class to represent model/scenario planning horizon with intervals (year-steps)

newHorizon() update(<horizon>) setHorizon(<config>) update(<config>): Create a new object of class 'horizon'

Solving

interpolate(<model>): Interpolate model

interpolate_bounds(): Interpolate lower and upper bounds

interpolate_numpar(): Interpolate numerical parameter for missing years

write_script() write_sc() write.sc(): Write scenario object as a Python, Julia, GAMS, or MathProg script with data files to a directory

read_solution() read(<scenario>): Read solution

solve_model() solve(<model>,<character>) solve_scenario() solve(<scenario>,<character>): Functions and methods to solve model and scenario objects

Data manimulation

convert(<character>) convert(<numeric>) add_to_convert(<character>,<character>,<numeric>): Convert units

convert_data: Basic units conversion database for convert methods

apply_to_scenario_data(): Apply function to scenario data

getData() get_data(): Extracts information from scenario objects, based on filters.

findData(): Performs search for available data in scenario object.

findDuplicates(): Function to find duplicated values in interpolated scenario.

renameSets(): Rename data.frame columns of list of data.frames.

revalueSets(): Replace specified values with new values in factor or character columns of a data.frame.

size(): Size of an object

hour2HOUR(): Convert hours (integer) values to HOUR set 'hNN'

yday2YDAY(): Convert year-days to YDAY set 'dNNN'

tsl_formats tsl_sets dtm2tsl() tsl2dtm(): Common formats of time-slices.

tsl2year() tsl2yday() tsl2hour() tsl2month(): Mapping function between time-slices and day of the year

tsl_guess_format(): Guess format of time-slices

drop_na_cols(): Drop columns in a data.frame with all NA values

obj2mem(): Loads objects from disk to memory

isInMemory(): Is object stored in memory?

register() experimental: Register an object in the registry.

get_registry(): Returns the current registry object.

save_scenario(): Save scenario object on disk in parquet format using arrow package.

load_scenario(): Load scenario (in progress)

Visualisation

draw(): Draw a schematic representation of a process

plot(<horizon>): Visualize a Horizon object

set_progress_bar() show_progress_bar(): Switch on/off and select/customize progress bar

Validation

check_name(): Check validity of object's names used in sets

levcost(): Calculate levelized costs of commodity production

Exporting

print(): Print methods for the energyRt classes

energyRt options and settings

newHorizon() update(<horizon>) setHorizon(<config>) update(<config>): Create a new object of class 'horizon'

newModel() setHorizon(<model>) getHorizon(<model>): Create new model object

set_scenarios_path() get_scenarios_path(): Set or get directory for/with scenarios

set_progress_bar() show_progress_bar(): Switch on/off and select/customize progress bar

set_gams_path() get_gams_path() set_gdxlib_path() get_gdxlib_path() set_glpk_path() get_glpk_path() set_julia_path() get_julia_path() set_python_path() get_python_path(): Set GAMS and GDX library directory

make_scenario_dirname(): Make a name for a scenario directory

utils

en_install_julia_pkgs(): Install Julia packages

collect_set_elements(): Search through model data for set elements

getData() get_data(): Extracts information from scenario objects, based on filters.

get_default_value(): Return default value for one, several, or all parameters

get_process_aux(): Get auxiliary commodities for each process

get_process_class(): Get class of processes

get_process_comm(): Commodities associated with a processes

get_process_inputs(): Get inputs of processes

get_process_invest_window(): Start and end years for process by region

get_process_outputs(): Get output commodities for each process

get_process_region(): Get regions for each process

get_process_timeframe(): Get operational timeframe of processes

get_registry(): Returns the current registry object.

get_slot_doc(): Retrieve slot details in rd-format

set_scenarios_path() get_scenarios_path(): Set or get directory for/with scenarios

set_gams_path() get_gams_path() set_gdxlib_path() get_gdxlib_path() set_glpk_path() get_glpk_path() set_julia_path() get_julia_path() set_python_path() get_python_path(): Set GAMS and GDX library directory

complete_set(): Complete a data frame with missing set elements

expand_na_rows() expand_na_regions() expand_na_years() expand_sets(): Expand rows with NA values in set columns

countdown_timer(): Countdown timer to use in R scripts

is_any(): Check if an element of a set is "ANY*" or NA

map_comm_timeframe(): Expand sets for parameter

named_list_to_df(): Convert a named list of vectors to a data frame