Man pages for UniK-INES/dexR
Analysing and Reporting DEX Experiments

calc_segmentsExtracts segment coordination from data.frame
calc_segments_twistedExtracts segment coordination from data.frame for a twisted...
clearing_calcCalculate the system marginal price (SMP) and the amount of...
clearing_calc_demandCalculate demand curve based on market data frame and a start...
clearing_calc_supplyCalculate supply curve based on market data frame and a start...
clearing_find_price_requestedFind the price for an amount of energy in a data frame of...
clients_num_identify_typeAdd a column with generation (Pv, Wind, StorageOut) and load...
createCompareReportCreate the comparison report
create_dexpaThe given/default dexpa object is dublicated, and sim$id and...
create_dexpasCreate a list of <code>dexpa</code> objects from vector of...
createFullReportCreate the full report
createSingleReportCreate a single run report (slides)
demo_prepare_db4figuresImport dumpfiles into DB to use for sample figures
dexRDexR
emggethttpportDetermine EMG port in multi-node (and other) setting
emggetportDetermine EMG port in multi-node (and other) setting
hl_clearingsingleGnerates a figure of clearing at starttime
hl_closeexperimentStop EMGs, dump database, create full report, shutdown...
hl_config_clearclientsDeletes users from PostreDB (except admin, enavi, inspector)
hl_config_clients2dbStores client and role data from CSV file to PostGreSQL...
hl_config_copycsvtemplatesCopy CSV template to new configuration folder
hl_config_exportMarketProductsExport market products from DB to CSV file.
hl_config_marketProducts2dbStores market products from CSV file to PostGreSQL database....
hl_experimentConcuct experiment from starting backend server to creation...
hl_experiment_awaitemgstartupSleep during EMG startup
hl_experiment_bootbackendBoots backend server (no configuration, no starting)
hl_experiment_clusterRuns experiments and create the required config folder (for...
hl_experiment_configemgCreate configuration for EMGs to experiment
hl_experiment_ensureFileLoggingEnsures file exists an redirects output.
hl_experiment_runbackendRun backend server to experiment
hl_experiment_runemgRun EMGs to experiment
hl_experiment_stopemgStop EMG clients. Disables SSL verification.
hl_figure_clearing_clearingPriceByCTbyProductRetrieve data and store figure about the clearing price per...
hl_figure_clearing_comp_clearingPriceByCTbyProductRetrieve data and store figure about the clearing price per...
hl_figure_clearing_comp_numConsideredRequestsRetrieve data and store figure about the number of considered...
hl_figure_clearing_numConsideredRequestsRetrieve data and store figure about the number of considered...
hl_figure_energycosts_requested_comp_avgByTypeStartTRetrieves requests data from DB and creates figure of...
hl_figure_energycosts_requested_comp_sumByStartTRetrieves requests data from DB and creates figure of...
hl_figure_energycosts_requested_sumByStartTRetrieves requests data from DB and creates figure of...
hl_figure_energycosts_requests_comp_giniByStartTRetrieves requests data from DB and creates figure of gini...
hl_figure_energycosts_requests_giniByStartTRetrieves requests data from DB and creates figure of gini...
hl_figure_energy_requested_byStatusByStartTRetrieves requests data from DB and creates figure of the...
hl_figure_energy_requested_comp_byStatusByStartTRetrieves requests data from DB and creates figure of...
hl_figure_energy_requested_comp_sumByStartTRetrieves requests data from DB and creates figure of...
hl_figure_energy_requested_comp_sumGenByTypeStartTRetrieves requests data from DB and creates figure of...
hl_figure_energy_requested_comp_sumLoadGenByStartTRetrieves requests data from DB and creates figure of...
hl_figure_energy_requested_sumByStartTRetrieves requests data from DB and creates figure of...
hl_figure_energy_requested_sumLoadGenByStartTRetrieves requests data from DB and creates figure of...
hl_figure_energy_status_comp_sumLoadGenByLocationAndStartTRetrieves requests data from DB and creates figure of...
hl_figure_power_status_comp_sumBalanceByLocationAndStartTRetrieves requests data from DB and creates figure of power...
hl_figure_power_status_comp_sumLoadGenByLocationAndStartTRetrieves requests data from DB and creates figure of...
hl_figure_prices_comp_histogramRetrieves requests data from DB and creates histogram of...
hl_figure_prices_requested_comp_byTypeStartTRetrieves requests data from DB and creates figure of...
hl_figure_requests_numClients_comp_ByStartTRetrieves requests data from DB and creates figure of the...
hl_figure_requests_numClients_comp_byStatusByStartTRetrieves requests data from DB and creates figure of the...
hl_figure_requests_numClients_comp_byTypeByStartTRetrieves requests data from DB and creates figure of the...
hl_figure_requests_numRequests_byProductByStartTRetrieves requests data from DB and creates figure of the...
hl_figure_requests_numRequests_byProductBySubmTRetrieves requests data from DB and creates figure of the...
hl_figure_requests_numRequests_byStatusByStartTRetrieves requests data from DB and creates figure of the...
hl_figure_requests_numRequests_byStatusBySubmTRetrieves requests data from DB and creates figure of the...
hl_figure_requests_numRequests_byTypeByStartTRetrieves requests data from DB and creates figure of the...
hl_figure_requests_numRequests_comp_byProductByStartTRetrieves requests data from DB and creates figure of the...
hl_figure_requests_numRequests_comp_byProductBySubmTRetrieves requests data from DB and creates figure of the...
hl_figure_requests_numRequests_comp_byStatusByStartTRetrieves requests data from DB and creates figure of the...
hl_figure_requests_numRequests_comp_byStatusBySubmTRetrieves requests data from DB and creates figure of the...
hl_figure_requests_numRequests_comp_byTypeByStartTRetrieves requests data from DB and creates figure of the...
hl_opsimRun OpSim control manager, schedule service, net simulation,...
hl_opsim_runmanagerRuns OpSim control manager
hl_opsim_runnetsimRun panda power net simulation in python
hl_opsim_runscheduleserviceRun Schedule Service
hl_opsim_startmarketStart market backend server (creating database, not shutting...
hl_raspicRuns experiments on the rasperry Pi cluster
hl_raspic_closesessionClose SSH session to raspberry Pi cluster
hl_raspic_runemgRun EMGs on raspberry Pi cluster
hl_raspic_transferemgconfigTransfer config dir to raspberry Pi cluster
hl_reports_compCreate a report for the given <code>ids</code> based on the...
hl_statistics_comp_costsRetrieves clearing and request information an outputs...
hl_statistics_comp_energyRetrieves clearing and request information an outputs...
hl_statistics_comp_giniTable with mean and sum of gini indices across time (load and...
hl_statistics_comp_numclientsRetrieves request information an outputs aggregated figures...
hl_statistics_costsRetrieves clearing and request information an outputs...
hl_statistics_energyRetrieves clearing and request information an outputs...
hl_write_runinfosAppend current run information to runInfos file.
input_csv_clientdataExtract and merge client data from CSV parameter files
input_csv_configparamReads params for the given dexpa from the parameter...
input_csv_runinfosExtract the runinfos entry from CSV file for the dexpa's sim...
input_db_clearingsRetrieve clearing data from PostgreSQL database.
input_db_createdbCreates the database configured in the given parameter object
input_db_db2dumpExports the database configured in the given parameter object...
input_db_dropdbDrop database that is defined in dexpa
input_db_dropdbsDrop databases which are defined in a list of dexpas
input_db_dump2dbImports the given dumpfile into the database configured in...
input_db_dumps2dbImport dumpfiles which are defined in a list of dexpas
input_db_getconnectionRetrieve a connection to the PostgreSQL DB specified in...
input_db_param_marketinfoRetrieve timing information from PostgreSQL database.
input_db_param_productsRetrieve market product information from PostgreSQL database.
input_db_param_usersRetrieve user parameters from PostgreSQL database.
input_db_requestsRetrieve request data from PostgreSQL database.
input_db_requests_clearingRetrieve energy requests to illustrate a single clearing...
input_db_runIDGenerate run ID string of the given database configuration.
map_requests2intervals_energyMaps request data to intervals and calculates residuals
ms_to_dateConvert milliseconds to POSIXct
output_figure_barsPrints a bar of data as ggplot2 with potentially different...
output_figure_clearing_comp_numConsideredRequests_byCTbyProductOutput figure: Number of considered requests per clearing and...
output_figure_clearing_comp_prices_byCTbyProductOutput figure: Cleared price per clearing by clearing time...
output_figure_clearing_comp_prices_bySTbyProductOutput figure: Cleared price per clearing by clearing time...
output_figure_clearing_numConsideredRequests_byCTbyProductOutput figure: Number of considered requests per clearing by...
output_figure_clearing_prices_byCTbyProductOutput figure: Cleared price per clearing by clearing time...
output_figure_clearing_prices_energy_bySTOutput figure: Cleared price per clearing by delivery start...
output_figure_clientdataPrints a bar of data as ggplot2 with potentially different...
output_figure_energycosts_requested_comp_avgByTypeStartTOutput figure: Comparison of average costs of requested...
output_figure_energycosts_requested_comp_giniByStartTOutput figure: Gini coefficient of costs of accepted energy...
output_figure_energycosts_requested_comp_sumByStartTOutput figure: Comparison of costs of requested energy sum...
output_figure_energycosts_requested_giniByStartTOutput figure: Gini coefficient of costs of accepted energy...
output_figure_energycosts_requested_sumByStartTOutput figure: Costs of requested energy sum per delivery...
output_figure_energy_requested_byStatusByStartTOutput figure: Requested energy per submission time and...
output_figure_energy_requested_comp_byStatusByStartTOutput figure: Requested energy per submission time and...
output_figure_energy_requested_comp_sumByLoadGenByStartTOutput figure: Requested energy per submission time and...
output_figure_energy_requested_comp_sumByStartTOutput figure: Requested energy per submission time and...
output_figure_energy_requested_comp_sumGenByGenTypeStartTOutput figure: Requested generation energy per generation...
output_figure_energy_requested_sumByLoadGenByStartTOutput figure: Requested energy per submission time and...
output_figure_energy_requested_sumByStartTOutput figure: Requested energy sum per submission time.
output_figure_energy_status_comp_sumByLocationLoadGenByStartTOutput figure: Requested energy for specific status per...
output_figure_initInit figure output
output_figure_linesPrints a lines of data as ggplot2 with potentially different...
output_figure_power_status_comp_sumByLocationBalanceByStartTOutput figure: Requested energy balance per area/location for...
output_figure_power_status_comp_sumByLocationLoadGenByStartTOutput figure: Requested energy for specific status per...
output_figure_prices_comp_histogramGenerate histogram of prices of load requests.
output_figure_prices_requested_comp_avgByTypeStartTOutput figure: Requested generation energy per generation...
output_figure_requests_numClients_comp_ByStartTOutput figure: Number of submitting clients per submission...
output_figure_requests_numClients_comp_byStatusByStartTOutput figure: Number of submitting clients per submission...
output_figure_requests_numClients_comp_byTypeByStartTOutput figure: Number of submitting clients per submission...
output_figure_requests_numRequests_byStatusByStartTOutput figure: Number of submitted requests per submission...
output_figure_requests_numRequests_byStatusBySubmTOutput figure: Number of considered requests by submission...
output_figure_requests_numRequests_comp_byProductByStartTOutput figure: Number of submitted requests per submission...
output_figure_requests_numRequests_comp_byProductBySubmTOutput figure: Number of considered requests by submission...
output_figure_requests_numRequests_comp_byStatusByStartTOutput figure: Number of submitted requests per submission...
output_figure_requests_numRequests_comp_byStatusBySubmTOutput figure: Number of considered requests by submission...
output_figure_requests_numRequests_comp_byTypeByStartTOutput figure: Number of submitted requests per submission...
output_figure_singleclearing_dePlots demand and supply curve for a single uniform price...
output_figure_singleclearing_enPlots demand and supply curve for a single uniform price...
output_figure_singleclearing_twistedPlots demand and supply curve for a single uniform price...
output_statistics_comp_costsCalculate aggregate figures of costs.
output_statistics_comp_energyCalculate aggregate figures of traded energy.
output_statistics_comp_giniShow aggregate gini figures in table per ID.
output_statistics_comp_numclientsCalculate aggregate figures of number of clients.
output_table_param_clientsReturns a kable markdown table with client information
output_table_param_marketinfoProvides markdown formated table of timing information.
output_table_param_productsProvides markdown formated table of product patterns.
param_clientsdifferCheck differences in client configuration (compare rows of...
param_clientsdiffer_runsCheck differences in client configuration (compare runs)
param_getDefaultDexpaGet the default dexpa parameter list
param_marketinfodifferCheck differences in market information
param_marketproductsdifferCheck differences in market product configuration
param_mergeDefaultDexpaMerge the given list into the default dexpa parameter list....
prepare_costdata_giniCalculate gini data
reexportsObjects exported from other packages
reports_level_mediumSet reporting of figures to medium level
requests_energy_identify_typeAdd a column with generation (Pv, Wind, StorageOut) and load...
requests_filter_dataFilter requests according to status and products
requests_identify_typeSums the expression in <code>dataexp</code> up separately for...
requests_num_identify_typeAdd a column with generation (Pv, Wind, StorageOut) and load...
requests_prices_identify_typeAdd a column with generation (Pv, Wind, StorageOut) and load...
server_isrunningChecks whether the server is ready for requests.
server_shutdownStop backend server
server_startStart backend server
server_statusRetrieve backend server status information
server_versionRetrieve backend server version
setup_environmentCopies machine-specific and project-specific config file...
setup_project_versionCopies config files <code>dexpa-pversion_pversion</code>, run...
str_to_msConvert time string to milliseconds
UniK-INES/dexR documentation built on June 30, 2021, 11:05 p.m.