README.Rmd

---
output: github_document
---

<!-- README.md is generated from README.Rmd. Please edit that file -->

```{r, include = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-",
  out.width = "100%"
)
```

# pacta.portfolio.audit <img src="man/figures/logo.png" align="right" width="120" />

<!-- badges: start -->
[![CRAN status](https://www.r-pkg.org/badges/version/pacta.portfolio.audit)](https://CRAN.R-project.org/package=pacta.portfolio.audit)
[![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental)
[![R-CMD-check](https://github.com/RMI-PACTA/pacta.portfolio.audit/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/RMI-PACTA/pacta.portfolio.audit/actions/workflows/R-CMD-check.yaml)
<!-- badges: end -->

The goal of pacta.portfolio.audit is to provide utility functions that 
enable the calculation of audit statistics for PACTA on the 
[Capital Transition Monitor Platform](https://platform.transitionmonitor.com/). 

## Installation

You can install the development version of pacta.portfolio.audit like so:

``` r
#install.packages("pak")
pak::pak("RMI-PACTA/pacta.portfolio.audit")
```

## Example

This is a basic example which shows you how to solve a common problem:

```{r example}
library(pacta.portfolio.audit)
## basic example code
```