makeDocs/reportTotalPower.R

In CfSOtago/GREENGridData: Processing NZ GREEN Grid project data to create a 'safe' version for data archiving and re-use

print(paste0("#--------------- Reporting NZ GREEN Grid Grid Household Total Power Data ---------------#"))

# Reports the results of running the imputeTotalPower.r script.
# Uses the pre-processed 'all households' file
# Runs parameterised reportTotalPower.Rmd to build report

# Libraries ----

library(lubridate)
library(data.table)
library(drake) # introduced to aid workflow - you'll see why
library(here)

# parameterise data path - edit for your set up ----
source(paste0(here::here(), "/ggrParams.R")) # has to be done here not within .Rmd. Why?

sysname <- Sys.info()[[1]]
user <- Sys.info()[[6]]
message("Running on ", sysname, " under user ", user)

#circuitsFile <- "circuitsToSum.csv"
#circuitsFile <- "circuitsToSum_v1.0" # JKM original
circuitsFile <- "circuitsToSum_v1.1" # all

# localise data paths
if(user == "ben" & sysname == "Darwin"){
  # Ben's laptop
  dPath <- "~/Data/NZ_GREENGrid/safe/gridSpy/1min/data"
  circuitsPath <- paste0(here::here(), "/publicData/", circuitsFile, ".csv") # in the package data folder
  dataFile <- paste0(dPath, "/imputed/all_1min_data_withImputedTotal_", circuitsFile, ".csv.gz")
  # hh attributes
  hhFile <- "~/Data/NZ_GREENGrid/reshare/v1.0/data/ggHouseholdAttributesSafe.csv.gz"
} else {
  dPath <- "/Users/jkmair/GreenGrid/data/clean_raw" # <- Jason
  dataFile <- paste0(dPath, "/imputed/allHouseholds_totalW_long_", circuitsFile, ".csv.gz")
}

# set up ----

start_exec <- Sys.time()

dataL <- data.table() # data bucket to collect data in

loadFile <- function(f){
  # loads any file we throw at it using data.table::fread
  if(file.exists(f)){
     dt <- data.table::fread(f) # load hh data - fread is VERY fast but does not auto-parse (which is helpful for the dateTimes)
   } else {
     message("Failed to find ", f," - is the data source available?")
   } 
  return(dt)
}

# set drake plan ----
rmdFile <- paste0(here::here(), "/makeDocs/reportTotalPower.Rmd")
message("Checking Rmd file to run exists: ", file.exists(rmdFile))

htmlFile <- paste0(here::here(), "/docs/reportTotalPower_",circuitsFile,".html")
title <- "GREENGrid Household Electricity Demand Data Test"
subtitle <- paste0('Imputed total power demand using: ', circuitsFile)
knitParams <- list(
  circuitsFile = circuitsFile,
  title = title,
  subtitle = subtitle
)

doReport <- function(){
  rmarkdown::render(
    knitr_in(rmdFile),
    params = knitParams,
    output_file = file_out(htmlFile),
    quiet = FALSE # change to TRUE for peace & quiet
  )
}

plan <- drake::drake_plan(
  powerData = loadFile(dataFile),
  hhData = loadFile(hhFile),
  circuits = data.table::fread(circuitsPath),
  report = doReport()
)


# test the plan ----
plan

config <- drake_config(plan)
vis_drake_graph(config)

# do the plan ----
make(plan)


end_exec <- Sys.time()
end_exec - start_exec