added documentation

greenGridr/man/findParentDirectory.Rd

+% 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/list1mGridSpyFiles.Rd

+% 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 'path'. Code borrows extensively from similar SAVE project function.
+   This could take quite a long time if you have a lot of files.
+}
+\author{
+Ben Anderson, \email{b.anderson@soton.ac.uk}
+}

greenGridr/man/myRequiredPackages.Rd

+% 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

+% 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}
+}