R package to perform Paris Agreement Capital Transition Assessment for corporate lending portfolio including matching and analysis module
Package includes useful functions and procedures which can be used by any user. Purpose of package is to implement support for standard workflow operartions. Users may use own workflows (different data formats, different match rules, etc) while still using standard building blocks.
All package makes available set of functions which are pure in their behaviour - so they fully depend on input and produce output only according to input. No IO operations are done inside functions. All file access for reads and writes are performed script level and not part of this package.
Simple package installation
Install R first from cran. Please install R into local folder. Due to many files R works slowly when it is installed on network drive.
Enter R envinronment, install additional packages
install.packages("devtools") devtools::install_github(repo = "2DegreesInvesting/pacta")
Installation of sources
Please note that
roxygen2 packages is required. This is easiest way to build packages in R. Please open R session and run following command
After that you can clone git repository into your working folder
git clone https://github.com/2DegreesInvesting/pacta.git
Now everything is ready, you can run RStudio and open project - there is a Rproj file in the root folder.
After project is open it needs to be built. Run
B to build project. R might request you to install additional packages used, please refer to
Imports: section of package DESCRIPTION.
Please refer to CONTRIBUTING document that describes workflow used for changes. Few important rules worth mentioning again:
- all changes are done via branches, no changes in
- first write test then write functionality - take care of automated testing;
- always biuld -
B- for documentation update;
- always test -
T- to make sure regression tests are passing;
- always check -
E- to make sure package passes integration tests and additional checks.
Please keep Warnings and Errors on zero level.
Please activate documentation generation during builds - go to Rstudio menu
Project options... ->
Build Tools -> activate flag
Generate documentation with Roxygen, theck click on
Configure button and mark
Automatically roxygenize when running /
Build & Reload