.github/CONTRIBUTING.md

In 2DegreesInvesting/pactaCore: What the Package Does (One Line, Title Case)

This document guides contributors. It extends README focusing on how this R package differs form a standard one.

• Some environment variables are convenient or required. A good place to set them is in a project-specific .Renviron file, e.g.:

PACTA_SKIP_SLOW_TESTS=FALSE
PACTA_DATA=/home/mauro/git/siblings/pacta-data

• pactaCore must be a sibling of a number of repositories. Clone them from 2DII’s GitHub organization and ensure your local clones are up to date with the repos on GitHub (to manage all siblings at once see pacta-pull-origin-master in pacta-cli).

git clone [e-mail]:2DegreesInvesting/create_interactive_report.git
git clone [e-mail]:2DegreesInvesting/PACTA_analysis.git
git clone [e-mail]:2DegreesInvesting/pacta-data.git
git clone [e-mail]:2DegreesInvesting/pactaCore.git
git clone [e-mail]:2DegreesInvesting/r2dii.climate.stress.test.git
git clone [e-mail]:2DegreesInvesting/r2dii.stress.test.data.git

• Git ignores all files under the directory tests/testthat/_snaps/ to avoid leaking private data. Re-include public snapshots in .gitignore with a negation pattern (!), e.g.:

tests/testthat/_snaps/**
!tests/testthat/_snaps/run_pacta.md
!tests/testthat/_snaps/run_web_tool.md

• Git ignores the directory tests/testthat/private/. Use it to store regression references or other private data.

/home/mauro/git/siblings/pactaCore/tests/testthat/private
├── pacta_core
│   └── TestPortfolio_Input
│       ├── Bonds_results_company.rda
│       ├── Bonds_results_map.rda
│       ├── Bonds_results_portfolio.rda
│       ├── Equity_results_company.rda
│       ├── Equity_results_map.rda
│       └── Equity_results_portfolio.rda
└── web_tool
    └── TestPortfolio_Input
        ├── Bonds_results_company.rda
        ├── Bonds_results_map.rda
        ├── Bonds_results_portfolio.rda
        ├── Equity_results_company.rda
        ├── Equity_results_map.rda
        └── Equity_results_portfolio.rda

You may compare two lists of reference datasets with the internal function compare_results().

2DegreesInvesting/pactaCore documentation built on Feb. 25, 2024, 3:20 a.m.