Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add different install instructions for release and dev #235

Merged
merged 3 commits into from
Nov 15, 2024
Merged

add different install instructions for release and dev #235

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e776c28
add different install instructions for release and dev
cjyetman Nov 13, 2024
8afa663
Update README.md
cjyetman Nov 13, 2024
8d4ee50
Merge branch 'main' into release-and-dev-install-instructions
cjyetman Nov 15, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 10 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@
<!-- badges: start -->
[![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.multi.loanbook/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/RMI-PACTA/pacta.multi.loanbook/actions/workflows/R-CMD-check.yaml)
[![CRAN
status](https://www.r-pkg.org/badges/version/pacta.multi.loanbook)](https://CRAN.R-project.org/package=pacta.multi.loanbook)
<!-- [![CRAN
status](https://www.r-pkg.org/badges/version/pacta.multi.loanbook)](https://CRAN.R-project.org/package=pacta.multi.loanbook) -->
[![pacta.multi.loanbook status badge](https://rmi-pacta.r-universe.dev/badges/pacta.multi.loanbook)](https://rmi-pacta.r-universe.dev/pacta.multi.loanbook)
<!-- badges: end -->

Expand All @@ -14,16 +14,19 @@ The `pacta.multi.loanbook` package offers a standardized, user-friendly way to c
Designed for financial supervisory contexts, it simplifies climate alignment analysis across many lending institutions. The package streamlines steps to prevent repetition while allowing flexibility to tailor the analysis for specific project needs, providing valuable insights into transition alignment and risk.

## Installation
Install the development version of the package from GitHub with:

<!--
You can install the release version of the package by running the following command in R:

``` r
# install.packages("pak")
pak::pak("RMI-PACTA/pacta.multi.loanbook")
install.packages("pacta.multi.loanbook")
```
-->

You can install the development version of the package from GitHub with:

Verify the installation with:
``` r
library(pacta.multi.loanbook)
pak::pak("RMI-PACTA/pacta.multi.loanbook")
```

## Usage
Expand Down
22 changes: 17 additions & 5 deletions vignettes/cookbook.Rmd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -207,17 +207,29 @@ RStudio is an integrated development environment (IDE) for R developed by Posit.

### `pacta.multi.loanbook` R package

The `pacta.multi.loanbook` package is the main software tool that you will use to run the PACTA for Supervisors analysis. You can install the package from the [RStudio CRAN mirror](https://cran.r-project.org/web/packages/pacta.multi.loanbook/index.html) by running the following command in R:
The `pacta.multi.loanbook` package is the main software tool that you will use to run the PACTA for Supervisors analysis.

```{r install_package, eval = FALSE}
::: {.pkgdown-release}
You can install the package from the [RStudio CRAN mirror](https://cran.r-project.org/web/packages/pacta.multi.loanbook/index.html) by running the following command in R:

``` r
install.packages("pacta.multi.loanbook")
```

Alternatively, you can install the development version of the package from GitHub by running the following command in R:
You can install the development version of pkgdown from GitHub with:

``` r
pak::pak("r-lib/pkgdown")
```
:::

::: {.pkgdown-devel}
You can install the development version of pkgdown from GitHub with:

```{r install_dev_package, eval = FALSE}
pak::pak("RMI-PACTA/pacta.multi.loanbook")
``` r
pak::pak("r-lib/pkgdown")
```
:::

### Required R packages

Expand Down