latest run & edits to data readme

impetusModel/dataReadme.Rmd

 ---
-title: "IMPETUS Model Data README"
+title: "README File for 'MPETUS Water Demand Microsimulation Model output'"
+subtitle: "Data DOI: https://doi.org/10.5258/SOTON/D1815"
 author: "Ben Anderson"
 date: 'Last run at: `r Sys.time()`'
 output:
@@ -22,6 +23,10 @@ library(kableExtra)
 
 f <- path.expand("~/University of Southampton/IMPETUS - Documents/data/model_outputs/output-allModels_baselineWE_DR_DT.csv.gz")
 
+fInfo <- file.info(f)
+
+fCreated <- fInfo[5]
+fSizeMb <- round(file.size(f)/1000000)
 
 dt <- data.table::fread(f)
 
@@ -33,7 +38,11 @@ nHHs <- uniqueN(dt$ID)
 
 This file describes the output data from the IMPETUS domestic water demand microsimulation models. 
 
-The models are described in:
+The permanent data DOI is:
+
+ * https://doi.org/10.5258/SOTON/D1815
+
+This dataset supports a number of publications which can be found at:
 
  * https://eprints.soton.ac.uk/cgi/search/simple?q=IMPETUS
 
@@ -43,14 +52,20 @@ The code used to build the models is available from:
  
 The original data used to construct the models is generally not publicly available but comprised:
 
- * the SPRG/ARCC Water Survey - see Browne, Alison, Ben Anderson, and Will Medd. 2011. ‘Lancaster SPRG/ARCC Water Survey’. Project Report. https://eprints.soton.ac.uk/439637/.
+ * the SPRG/ARCC Domestic Water Use Survey - see Browne, Alison, Ben Anderson, and Will Medd. 2011. ‘Lancaster SPRG/ARCC Water Survey’. Project Report. https://eprints.soton.ac.uk/439637/.
  * seasonal demand adjustment coefficients derived from Parker, Joanne M. 2014. “Assessing the Sensitivity of Historic Micro-Component Household Water-Use to Climatic Drivers.” A Doctoral Thesis. submitted in partial fulfilment of the requirements for the award of Doctor of Philosophy of Loughborough University, Loughborough: Loughborough. https://dspace.lboro.ac.uk/2134/14939.
  * CEH reconstructed drought histories for the Colne catchment in East Anglia for 1994-2012 from Parry, Simon, Robert L. Wilby, Christel Prudhomme, and Paul J. Wood. 2016. ‘A Systematic Assessment of Drought Termination in the United Kingdom’. Hydrology and Earth System Sciences 20 (10): 4265.
  * MetOffice monthly rainfall and temperature data for the East of England for 1994-2012 sourced from https://www.metoffice.gov.uk/research/climate/maps-and-data/uk-and-regional-series
 
+# License
+
+ * CC-BY https://creativecommons.org/licenses/by/4.0/
+
 # The data
 
-The data file contains a record for every SPRG household (n = `r nHHs`) projected forwards for each month in the period 1994 - 2012 (with incomplete years in 1994 and 2012) for each of a number of model versions
+The version of the data file to which this README refers was created at `r fCreated[[1]]` and is approximately `r fSizeMb` MB in size (gzipped).
+
+The data file contains a record for every SPRG household (n = `r nHHs`) projected forwards for each month in the period 1994 - 2012 (with incomplete years in 1994 and 2012) for each of a number of model versions.
 
 This means that the number of records per model per year are as shown in Table \@ref(tab:yearCounts) and the total number of records is `r dkUtils::tidyNum(nrow(dt))`.