README.md

In austl001/MOSLR: MOSL Reports and Utility Functions

MOSLR

The MOSLR package is intended for:

• The automated generation of PDF performance reports (so-called "PFM Reports") each month
• To facilitate MOSL's Performance Rectification process by producing required performance statistics and tracking decisions as part of Initial Performance Rectification Plans (IPRP) and Performance Rectification Plans (PRPs)
• Storing several useful functions for various actions, such as adding MOSL brand colours to charts

Installation

You can install the released version of MOSLR from GitHub with:

devtools::install_github("MarketOperatorServicesLtd/MOSLR", auth_code = "GITHUB_PAT")

Example

This is an example script showing how to run the monthly performance reporting and produce the PFM reports:

library(MOSLR)

# Data Assurance Process ------------------------------------------------------------------------------------

log_table <- tibble::tibble()
log_book <- MOSLR::data_assurance_process(conf.loc = config_loc, clean.sharepoint = FALSE, upload.blob = FALSE, upload.log = FALSE)
log_table <- MOSLR::data_assurance_process()


# Performance Reporting ----------------------------------------------------------------------------------------

tinytex.loc <- "F:\\TinyTex"
my.dir <- "F:\\Market Performance\\MOSLR"
conf.loc <- "F:\\GitAnalysisRepo\\config.yml"

if(!tinytex::is_tinytex()) {
  tinytex::use_tinytex(tinytex.loc)
}

# Market Performance Standards (MPS) ---------------------------------------------------------------------------

mps_data <- mps_data_prep(my.dir = my.dir, conf.loc = conf.loc)
mps_tracking <- mps_create_tracker(my.dir = my.dir, conf.loc = conf.loc) 
mps_perf_status <- mps_process_tracker(my.dir = my.dir, conf.loc = conf.loc)

# Additional Performance Indicators (APIs) ---------------------------------------------------------------------

API_tracking <- mps_create_tracker(my.dir = my.dir, StandardKey = "API", conf.loc = conf.loc) 
API_perf_status <- mps_process_tracker(my.dir = my.dir, StandardKey = "API", conf.loc = conf.loc)

# Operational Performance Standards (OPS) ---------------------------------------------------------------------

ops_data <- ops_data_prep(my.dir = my.dir, conf.loc = conf.loc)
ops_tracking <- ops_create_tracker(my.dir = my.dir, conf.loc = conf.loc)
ops_perf_status <- ops_process_tracker(my.dir = my.dir, conf.loc = conf.loc)

# Performance Graphs

plot_perf_graphs_all(my.dir = my.dir, conf.loc = conf.loc, run.parallel = FALSE, mps.graphs = FALSE, ops.graphs = FALSE, iprp.graphs = FALSE)

# Render PFM Report (where period = month the data relates to) ### Run for one Trading Party Only

render_PFM_report(my.dir = my.dir, conf.loc = conf.loc, prep.data = FALSE, data.period = format(Sys.Date(), "%Y-%m-01"), tp.list = c("THAMES-W", "CASTLE-R"))

# Render ALL PFM Reports (where period = month the data relates to)

render_PFM_report(my.dir = my.dir, prep.data = FALSE, data.period = format(Sys.Date(), "%Y-%m-01"))

For further details contact the Data Team.

austl001/MOSLR documentation built on Aug. 17, 2022, 12:07 a.m.