Public | Automated Build

Last pushed: a month ago
Short Description
Image with R install and code for the CaDC Water Use Efficiency Report (wueReport)
Full Description

Water Use Efficiency Reports

This repo contains an R package for generating a custom water use efficiency (WUE) report for a CaDC member utility in the SCUBA data warehouse.

Read the Wiki for Key Project Goals and Responsibilities

Contributing

Please see the contributing page for details on how to develop this report.

Getting Started

The report can be generated locally, but it works best when executed within the corresponding Docker container.

Within Docker

It is recommended to generate the report from within the Docker container as follows:

docker run -it --env-file path/to/envfile -v /local/output/dir:/wueReport/report_output argolabs/wuereport R -e "wueReport::renderWueReport('/wueReport', 'utility_name')"

where 'utility_name' is the acronym for the utility for which you wish to generate a report (e.g. "MNWD").

Running locally

Clone the repository to your local machine and cd into the repo directory.

git clone https://github.com/California-Data-Collaborative/wueReport.git

cd wueReport

Then, within your R environment, install the local package.

devtools::install(".")

Then a custom report for a water utility can be generated for the most recent available data month using

wueReport::renderWueReport('path/to/package/root', 'utility_name')

where 'path/to/package/root' is the package directory (e.g. "~/wueReport") and 'utility_name' is the acronym for the utility for which you wish to generate a report (e.g. "MNWD").

Docker Pull Command
Owner
argolabs

Comments (0)