diff --git a/greenGridr/man/list1mGridSpyFiles.Rd b/greenGridr/man/list1mGridSpyFiles.Rd index 0afffb79240c6a385abcc7d84c9c7963d4cada0c..11c463168f5903eb0d149e86c40d5c6699631c97 100644 --- a/greenGridr/man/list1mGridSpyFiles.Rd +++ b/greenGridr/man/list1mGridSpyFiles.Rd @@ -13,8 +13,9 @@ list1mGridSpyFiles(fpath, pattern) } \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 'path'. Code borrows extensively from similar SAVE project function. - This could take quite a long time if you have a lot of files. + 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} diff --git a/greenGridr/man/process1mGridSpyFiles.Rd b/greenGridr/man/process1mGridSpyFiles.Rd new file mode 100644 index 0000000000000000000000000000000000000000..705d133ecc5e9a1a75a838198b82ad1fa8ff167a --- /dev/null +++ b/greenGridr/man/process1mGridSpyFiles.Rd @@ -0,0 +1,18 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/processGridSpyFiles.R +\name{process1mGridSpyFiles} +\alias{process1mGridSpyFiles} +\title{Load all available 1 minute grid spy data files from the list returned by list1mGridSpyFiles} +\usage{ +process1mGridSpyFiles(dt) +} +\arguments{ +\item{dt}{a data table with 2 columns: hhID and fullPath derived from list1mGridSpyFiles()} +} +\description{ +\code{process1mGridSpyFiles}. Loads, processes ans saves 1 minute grid spy files by iterating over each household id. We we cannot just concatinate all the files since the + column headings (circuit labels) vary. The function saves out 1 data file per household ID per month as a gzipped .csv file. +} +\author{ +Ben Anderson, \email{b.anderson@soton.ac.uk} +}