Using the iTEM MIP2 R scripts¶
Installation¶
Use devtools. From source (for instance, to develop the code locally):
$ git clone git@github.com:transportenergy/database.git
$ Rscript -e "devtools::install_local('database/R/item')"
Or without cloning the repository:
devtools::install_github('transportenergy/database/R/item')
Usage¶
From R scripts:
library(item)
# Load version 1 of the iTEM models database
data <- item::load_model_data(1)
From the command-line: run
is an executable that invokes item::cli()
.
It can be used without installing the package:
$ ./run
Loading item
Usage: ./run [OPTIONS] COMMAND
Command-line interface for the iTEM databases.
…
Commands:
mkdirs
debug
load_model_data
Development¶
Code conventions and packaging follow the “R packages” book.
test
is an executable that runs the tests in R/item/tests/testthat
.
The environment variable ITEM_TEST_DATA
must be defined in order for these tests to work:
$ export ITEM_TEST_DATA=../../data/model/database
$ ./test
Loading item
Loading required package: testthat
Testing item
Model database: .
DONE =================================