impetusModel.Rmd

title: "A household level daily consumption estimation microsimulation model"
author: Ben Anderson (b.anderson@soton.ac.uk, `@dataknut`), Despoina Manouseli (d.manouseli@soton.ac.uk)
  & Magesh Nagarajan (m.nagarajan@soton.ac.uk)
date: 'Last run at: `r Sys.time()`'
output:
  html_document:
    keep_md: yes
    number_sections: yes
    self_contained: no
    toc: yes
    toc_depth: 4
    toc_float: yes
  pdf_document:
    number_sections: yes
    toc: yes
    toc_depth: 4
    toc_float: yes
  word_document:
    fig_caption: yes
    keep_md: yes
    toc: yes
    toc_depth: 4
bibliography: '`r paste0(here::here(), "/bibliography.bib")`'
knitr::opts_chunk$set(echo = TRUE) # echo code so reader can see what is happening
knitr::opts_chunk$set(warning = FALSE)
knitr::opts_chunk$set(message = FALSE)
knitr::opts_chunk$set(fig_caption = TRUE)
knitr::opts_chunk$set(fig_height = 6) # default, make it bigger to stretch vertical axis
knitr::opts_chunk$set(fig_width = 8) # full width
knitr::opts_chunk$set(tidy = TRUE) # tidy up code in case echo = TRUE
# Housekeeping ----

# Set start time ----
startTime <- proc.time()

# Where are we?
sysInfo <- Sys.info()
sysName <- sysInfo[[1]]
nodeName <- sysInfo[[4]]
userName <- sysInfo[[7]]

# default code location - needed to load functions & parameters correctly so
# has to be run here and not in the functions file as we can't find the functions file without it!
library(here)

projLoc <- here::here()

# Functions ----
print(paste0("Loading functions from ", projLoc,"/impetusFunctions.R"))
source(paste0(projLoc,"/impetusFunctions.R"))

# Load libraries ----
# NB libraries required by saveFunctions.R should already be loaded
reqLibsLocal <- c("data.table", # fast data manipulation
                  #"foreign", # STATA data load
                  #"sqldf", # sql-like functionality
                  "ggplot2", # slick graphs
                  "readr", # for read_csv
                  #"mefa", # ??
                  "plyr", # fast data munching & rename
                  "fGarch", # to create consumption distributions
                  #"doBy", # for summaryBy
                  "stargazer", # for neat summary & regression tables
                  "lubridate", # for date manipulation
                  "knitr" # for kable
                     )
print(paste0("Loading the following libraries using lb_myRequiredPackages: ", reqLibsLocal))
# Use Luke's function to require/install/load
lb_myRequiredPackages(reqLibsLocal,"http://cran.rstudio.com/")

# Parameters ----
# Do this here AFTER loading libraries
print(paste0("Loading parameters from ", projLoc,"/impetusParameters.R"))
source(paste0(projLoc,"/impetusParameters.R"))

# give feedback
print(paste0("Running on ", sysName, " with projLoc = ", projLoc)) # sysName is set in impetusParameters.R

# top level data paths are set in impetusParameters.R
print(paste0("User: ",userName))
print(paste0("Platform: ",sysName))
print(paste0("Input data path: ",iPath))
print(paste0("Output data path: ",oPath))

# do not set any other paths here as it will vary by model

# set drought phase colours
develCol <- "yellow1" # Developing
droughtCol <- "orange" # Drought
sevDroughtCol <- "red" # Severe Drought
recoveringCol <- "yellowgreen" # Recovering
# Import generic data
# Run model 1 baseline estimation & tests and write out synthetic household file
# Run model 2 baseline estimation & tests and write out synthetic household file
# Construct historical consumption levels for each month
# Run water efficiency model
# Run water efficiency model
t <- proc.time() - startTime

elapsed <- t[[3]]