Skip to content
Snippets Groups Projects
Commit bafee1b8 authored by Ben Anderson's avatar Ben Anderson
Browse files

moved green grid stuff to new repo

parent 5bef60a8
No related branches found
No related tags found
No related merge requests found
Hide whitespace changes
Inline Side-by-side
Showing
with 0 additions and 490 deletions
greenGrid/processGridSpyData.R deleted 100644 → 0
+ 0
− 82
View file @ 5bef60a8
#### About ----
# Code to process NZ GREEN Grid grid spy data
#### Libraries ----
library(data.table)
library(lubridate) # keep here otherwise data.table masks various functions
library(readr)
library(greenGridr)
#### Local parameters ----
fpath <- "/Volumes/hum-csafe/Research Projects/GREEN Grid/_RAW DATA/GridSpyData/" # location of data
#fpath <- "~/Data/NZGreenGrid/gridspy/1min_orig/" # location of data
pattern <- "*at1.csv$" # filters only 1 min data
outPath <- "/Volumes/hum-csafe/Research Projects/GREEN Grid/Clean_data/gridSpy/1min/" # place to save them
#outPath <- "~/Data/NZGreenGrid/gridspy/consolidated/"
dataThreshold <- 3000 # assume any files smaller than this (bytes) = no data
### Code ----
# Get the full 1 minute file listing ----
filesDT <- list1mGridSpyFiles(fpath, pattern)
filesDT <- filesDT[, c("hhID","fileName") := tstrsplit(V1, "/")]
filesDT <- filesDT[, fullPath := paste0(fpath, hhID,"/",fileName)]
print(paste0("Found ", nrow(filesDT), " files from ", uniqueN(filesDT$hhID), " households."))
# check
head(filesDT)
# Load, process & save the ones which probably have data ----
hhIDs <- unique(filesDT$hhID) # list of household ids
allFileInfoDT <- data.table()
for(hh in hhIDs){
print(paste0("Loading: ", hh))
tempHhDT <- data.table() # create data.table to hold file contents
filesToLoad <- filesDT[hhID == hh, fullPath]
for(f in filesToLoad){
# check file
# print(paste0("Checking: ", f))
rf <- path.expand(f) # just in case of ~ etc
finfo <- file.info(rf)
allFileInfoDT <- rbind(allFileInfoDT, as.data.table(finfo))
fsize <- file.size(rf)
if(fsize > dataThreshold){ # set above
print(paste0("Checking: ", f))
print(paste0("File size = ", file.size(f), " so probably OK")) # files under 3kb are probably empty
# attempt to load the file
tempDT <- fread(f)
tempHhDT <- rbind(tempHhDT, tempDT, fill = TRUE) # just in case there are different numbers of columns (quite likely!)
}
}
# tidy column names
tempHhDT$r_dateTime <- tempHhDT$"date NZ"
tempHhDT$"date NZ" <- NULL #to avoid confusion
# remove duplicates caused by over-lapping files
nObs <- nrow(tempHhDT)
print(paste0("N rows before removal of dublicates: ", nObs))
tempHhDT <- unique(tempHhDT)
nObs <- nrow(tempHhDT)
print(paste0("N rows after removal of dublicates: ", nObs))
# set month
tempHhDT$month <- month(tempHhDT$r_dateTime) # requires lubridate
tempHhDT$year <- year(tempHhDT$r_dateTime) # requires lubridate
# > save out by year & month ----
months <- unique(tempHhDT$month)
years <- unique(tempHhDT$year)
for(m in months){
for(y in years){
ofile <- paste0(outPath, hh,"_", y, "_", m, "_all_1min_data.csv")
write_csv(tempHhDT[month == m & year == y], ofile)
print(paste0("Saved ", ofile))
#cmd <- paste0("gzip -f ", ofile) # gzip it
#try(system(cmd)) # in case it fails - if it does there will just be .csv files (not gzipped) - e.g. under windows
}
}
}
summary(allFileInfoDT)
greenGridr/DESCRIPTION deleted 100644 → 0
+ 0
− 12
View file @ 5bef60a8
Package: greenGridr
Type: Package
Title: Functions for processing NZ GREEN Grid project data
Version: 0.1.0
Author: Ben Anderson
Maintainer: Ben Anderson <b.anderson@soton.ac.uk>
Description: The NZ GREEN Grid project collected electricity consumption data for each circuit of XXX NZ dwellings over a period of XX months from Year1 to Year 2.
The project also collected household survey and time-use diary data on specific dates. This package provides a set of functions to process and link this data. Note that the data is _not_ included in the package.
License: Apache License Version 2.0
Encoding: UTF-8
LazyData: true
RoxygenNote: 6.0.1
greenGridr/LICENSE deleted 100644 → 0
+ 0
− 201
View file @ 5bef60a8
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright 2018 Ben Anderson
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
greenGridr/NAMESPACE deleted 100644 → 0
+ 0
− 1
View file @ 5bef60a8
exportPattern("^[[:alpha:]]+")
greenGridr/R/dependencies.R deleted 100644 → 0
+ 0
− 4
View file @ 5bef60a8
# State required packages
#' @import data.table
#' @import lubridate
#' @import readr
greenGridr/R/processGridSpyFiles.R deleted 100644 → 0
+ 0
− 19
View file @ 5bef60a8
#' List all available 1 minute grid spy data files from a given path
#'
#' \code{list1mGridSpyFiles}. Lists all available 1 minute grid spy files from data repository. The functions, like most others in this package will fail
#' if you do not have the data in a folder/directory corresponding to 'fpath'. Code borrows extensively from similar SAVE project function.
#' This could take quite a long time if you have a lot of files. The function returns a data table with 2 columns: hhID (household id) and fullPath (full path to each file)
#' We need the hhID as we cannot just concatinate all the files since the column headings (circuit labels) vary.
#' @param fpath the name of the directory where the function should look
#' @param pattern a pattern to match. Use the pattern to filter e.g. 1m (xx_at1.csv) from 30s () files
#'
#' @author Ben Anderson, \email{b.anderson@@soton.ac.uk}
#' @export
#'
list1mGridSpyFiles <- function(fpath, pattern){
print(paste0("Looking for files matching ", pattern, " in ", fpath))
dt <- as.data.table(list.files(path = fpath, pattern = pattern, # use the pattern to filter e.g. 1m from 30s files
recursive = TRUE))
return(dt)
}
greenGridr/R/utilities.R deleted 100644 → 0
+ 0
− 63
View file @ 5bef60a8
#' Tidy long numbers
#'
#' \code{tidyNum} reformats long numbers to include commas and prevents scientific formats
#'
#' @param number an input number or list
#'
#' @author Ben Anderson, \email{b.anderson@@soton.ac.uk}
#' @export
#'
tidyNum <- function(number) {
format(number, big.mark=",", scientific=FALSE)
}
#' Find the path to Parent Directory
#'
#' Equivalent of \code{findParentDirectory}. Is useful for running a project
#' across multiple computers where the project is stored in different directories.
#'
#' @param Parent the name of the directory to which the function should track back.
#' Should be the root of the GitHub repository
#'
#' @author Mikey Harper, \email{m.harper@@soton.ac.uk}
#' @export
#'
findParentDirectory <- function(Parent){
directory <-getwd()
while(basename(directory) != Parent){
directory <- dirname(directory)
}
return(directory)
}
#' Installs and loads packages
#'
#' \code{myRequiredPackages} checks whether the package is already installed,
#' installing those which are not preinstalled. All the libraries are then load.
#'
#' Especially useful when running on virtual machines where package installation
#' is not persistent (Like UoS sve). It will fail if the packages need to be
#' installed but there is no internet access
#' @param ... A list of packages
#' @param repository The repository to load functions from. Defaults to "https://cran.ma.imperial.ac.uk/"
#' @importFrom utils install.packages
#'
#' @author Luke Blunden, \email{lsb@@soton.ac.uk} (original)
#' @author Michael Harper \email{m.harper@@soton.ac.uk} (revised version)
#' @export
#'
myRequiredPackages <- function(..., repository = "https://cran.rstudio.com"){
packages <- c(...)
# Find if package isn't installed
newPackages <- packages[!(packages %in% utils::installed.packages()[,1])]
# Install if required
if (length(newPackages)){utils::install.packages(newPackages, dependencies = TRUE)}
# Load packages
sapply(packages, require, character.only = TRUE)
}
greenGridr/README.md deleted 100644 → 0
+ 0
− 11
View file @ 5bef60a8
# greenGridr
Package of functions to process [NZ GREEN Grid](https://www.otago.ac.nz/centre-sustainability/research/energy/otago050285.html) data.
See package [DESCRIPTION](DESCRIPTION) file for (some) more info.
### Terms of code re-use
Read the [License](LICENSE) file.
[YMMV](http://en.wiktionary.org/wiki/YMMV)
greenGridr/man/findParentDirectory.Rd deleted 100644 → 0
+ 0
− 19
View file @ 5bef60a8
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/utilities.R
\name{findParentDirectory}
\alias{findParentDirectory}
\title{Find the path to Parent Directory}
\usage{
findParentDirectory(Parent)
}
\arguments{
\item{Parent}{the name of the directory to which the function should track back.
Should be the root of the GitHub repository}
}
\description{
Equivalent of \code{findParentDirectory}. Is useful for running a project
across multiple computers where the project is stored in different directories.
}
\author{
Mikey Harper, \email{m.harper@soton.ac.uk}
}
greenGridr/man/hello.Rd deleted 100644 → 0
+ 0
− 12
View file @ 5bef60a8
\name{hello}
\alias{hello}
\title{Hello, World!}
\usage{
hello()
}
\description{
Prints 'Hello, world!'.
}
\examples{
hello()
}
greenGridr/man/list1mGridSpyFiles.Rd deleted 100644 → 0
+ 0
− 22
View file @ 5bef60a8
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/processGridSpyFiles.R
\name{list1mGridSpyFiles}
\alias{list1mGridSpyFiles}
\title{List all available 1 minute grid spy data files from a given path}
\usage{
list1mGridSpyFiles(fpath, pattern)
}
\arguments{
\item{fpath}{the name of the directory where the function should look}
\item{pattern}{a pattern to match. Use the pattern to filter e.g. 1m (xx_at1.csv) from 30s () files}
}
\description{
\code{list1mGridSpyFiles}. Lists all available 1 minute grid spy files from data repository. The functions, like most others in this package will fail
if you do not have the data in a folder/directory corresponding to 'fpath'. Code borrows extensively from similar SAVE project function.
This could take quite a long time if you have a lot of files. The function returns a data table with 2 columns: hhID (household id) and fullPath (full path to each file)
We need the hhID as we cannot just concatinate all the files since the column headings (circuit labels) vary.
}
\author{
Ben Anderson, \email{b.anderson@soton.ac.uk}
}
greenGridr/man/myRequiredPackages.Rd deleted 100644 → 0
+ 0
− 27
View file @ 5bef60a8
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/utilities.R
\name{myRequiredPackages}
\alias{myRequiredPackages}
\title{Installs and loads packages}
\usage{
myRequiredPackages(..., repository = "https://cran.rstudio.com")
}
\arguments{
\item{...}{A list of packages}
\item{repository}{The repository to load functions from. Defaults to "https://cran.ma.imperial.ac.uk/"}
}
\description{
\code{myRequiredPackages} checks whether the package is already installed,
installing those which are not preinstalled. All the libraries are then load.
}
\details{
Especially useful when running on virtual machines where package installation
is not persistent (Like UoS sve). It will fail if the packages need to be
installed but there is no internet access
}
\author{
Luke Blunden, \email{lsb@soton.ac.uk} (original)
Michael Harper \email{m.harper@soton.ac.uk} (revised version)
}
greenGridr/man/tidyNum.Rd deleted 100644 → 0
+ 0
− 17
View file @ 5bef60a8
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/utilities.R
\name{tidyNum}
\alias{tidyNum}
\title{Tidy long numbers}
\usage{
tidyNum(number)
}
\arguments{
\item{number}{an input number or list}
}
\description{
\code{tidyNum} reformats long numbers to include commas and prevents scientific formats
}
\author{
Ben Anderson, \email{b.anderson@soton.ac.uk}
}
greenGridr_0.1.0.tar.gz deleted 100644 → 0
+ 0
− 0
View file @ 5bef60a8
File deleted
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment