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%"
)
```

# tiltIndicator

<!-- badges: start -->
[![tiltIndicator status badge](https://2degreesinvesting.r-universe.dev/badges/tiltIndicator)](https://2degreesinvesting.r-universe.dev/tiltIndicator)
[![R-CMD-check](https://github.com/2DegreesInvesting/tiltIndicator/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/2DegreesInvesting/tiltIndicator/actions/workflows/R-CMD-check.yaml)
[![Codecov test coverage](https://codecov.io/gh/2DegreesInvesting/tiltIndicator/branch/main/graph/badge.svg)](https://app.codecov.io/gh/2DegreesInvesting/tiltIndicator?branch=main)
[![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental)
<!-- badges: end -->

The goal of tiltIndicator is to implement the core business logic of the 'TILT'
indicators.

## Installation

You can install the latest release from [r-universe](https://r-universe.dev/)
with:

``` r
install.packages("tiltIndicator", repos = c("https://2degreesinvesting.r-universe.dev", getOption("repos")))
```

Or the development version from [GitHub](https://github.com/) with:

``` r
# install.packages("pak")
pak::pak("2DegreesInvesting/tiltIndicator")
```

Having trouble? Try it on a fresh new project on <https://posit.cloud/>
(free).

## Example

```{r child=tiltIndicator:::template_to_rmd("example-emissions_profile.R")}
```

For more examples see [Get started](https://2degreesinvesting.github.io/tiltIndicator/articles/tiltIndicator.html).