Prepare Release 0.1.0 (#352)

* Add NEWS.md * use cran comments * update install instructions in README * format attribution of data sources * DESCRIPTION Title in title case, based on extrachecks * update DESCRIPTION Description based on extrachecks * another update to DESCRIPTION Description based on extrachecks * align copyright holder to RMI * update URLs * use canonical form of CRAN URL * polish NEWS.md * build README * comment out CRAN URL for after release * update cran-comments.md * temp add _R_CHECK_CRAN_INCOMING_ * remove _R_CHECK_CRAN_INCOMING_ again * Increment version number to 0.1.0 * use single quotes for unknown words in DESCRIPTION * Revert "Increment version number to 0.1.0" This reverts commit 010acb4. * delete NEWS.md
RMI-PACTA · Dec 13, 2024 · d0f4588 · d0f4588
1 parent f443f73
commit d0f4588
Show file tree

Hide file tree

Showing 8 changed files with 119 additions and 22 deletions.
diff --git a/.Rbuildignore b/.Rbuildignore
@@ -8,3 +8,5 @@
 ^pkgdown$
 ^data-raw$
 ^codecov\.yml$
+^cran-comments\.md$
+^README\.Rmd$
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -1,5 +1,5 @@
 Package: pacta.multi.loanbook
-Title: Run PACTA on multiple loan books easily
+Title: Run 'PACTA' on Multiple Loan Books Easily
 Version: 0.0.0.9000
 Authors@R:
     c(
@@ -30,10 +30,11 @@ Authors@R:
         email = "[email protected]"
       )
     )
-Description: This repo allows running PACTA analyses on multiple loan books in a
-    structured way and provides access to additional PACTA-related metrics for
-    multiple loan books. Results take the form of csv files and plots and are
-    exported to specified project paths.
+Description: Run Paris Agreement Capital Transition Assessment ('PACTA') analyses
+    on multiple loan books in a structured way. Provides access to standard
+    'PACTA' metrics and additional 'PACTA'-related metrics for multiple loan books.
+    Results take the form of 'csv' files and plots and are exported to
+    user-specified project paths.
 Encoding: UTF-8
 Imports:
     cli (>= 3.2.0),

diff --git a/LICENSE.md b/LICENSE.md
@@ -1,6 +1,6 @@
 # MIT License
 
-Copyright (c) 2024 RMI-PACTA
+Copyright (c) 2024 RMI
 
 Permission is hereby granted, free of charge, to any person obtaining a
 copy of this software and associated documentation files (the

diff --git a/README.Rmd b/README.Rmd
@@ -0,0 +1,53 @@
+---
+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.multi.loanbook <a href="https://rmi-pacta.github.io/pacta.multi.loanbook/"><img src="man/figures/logo.png" align="right" height="31" /></a>
+
+
+<!-- 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) -->
+[![codecov](https://app.codecov.io/gh/RMI-PACTA/pacta.multi.loanbook/graph/badge.svg)](https://app.codecov.io/gh/RMI-PACTA/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 -->
+
+The `pacta.multi.loanbook` package offers a standardized, user-friendly way to calculate climate alignment metrics for multiple loan books, based on the PACTA methodology.
+
+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.
+
+<img src="man/figures/pml_readme_viz.png" width="100%" style="display: block; margin: auto auto auto 0;" />
+
+## Installation
+
+You can install the release version of the package by running the following command in R:
+
+``` r
+install.packages("pacta.multi.loanbook")
+```
+
+You can install the development version of the package from GitHub with:
+
+``` r
+# install.packages("pak")
+pak::pak("RMI-PACTA/pacta.multi.loanbook")
+```
+
+## Usage
+
+Please consult the following resource for instructions on using the package. The cookbook provides a detailed overview covering the setup of the necessary software environment, obtaining and preparing input data, running the analysis, and interpreting the results.
+
+- [Cookbook](https://rmi-pacta.github.io/pacta.multi.loanbook//articles/cookbook_overview.html): A comprehensive guide for setting up, running and interpreting the analysis.
diff --git a/README.md b/README.md
@@ -1,39 +1,55 @@
-# pacta.multi.loanbook <a href="https://rmi-pacta.github.io/pacta.multi.loanbook"><img src="man/figures/logo.png" align="right" height="31" /></a>
 
+<!-- README.md is generated from README.Rmd. Please edit that file -->
+
+# pacta.multi.loanbook <a href="https://rmi-pacta.github.io/pacta.multi.loanbook/"><img src="man/figures/logo.png" align="right" height="31" /></a>
 
 <!-- badges: start -->
-[![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental)
+
+[![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) -->
-[![codecov](https://codecov.io/gh/RMI-PACTA/pacta.multi.loanbook/graph/badge.svg)](https://codecov.io/gh/RMI-PACTA/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)
+[![codecov](https://app.codecov.io/gh/RMI-PACTA/pacta.multi.loanbook/graph/badge.svg)](https://app.codecov.io/gh/RMI-PACTA/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 -->
 
-The `pacta.multi.loanbook` package offers a standardized, user-friendly way to calculate climate alignment metrics for multiple loan books, based on the PACTA methodology.
+The `pacta.multi.loanbook` package offers a standardized, user-friendly
+way to calculate climate alignment metrics for multiple loan books,
+based on the PACTA methodology.
 
-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.
+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.
 
 <img src="man/figures/pml_readme_viz.png" width="100%" style="display: block; margin: auto auto auto 0;" />
 
 ## Installation
 
-<!--
-You can install the release version of the package by running the following command in R:
+You can install the release version of the package by running the
+following command in R:
 
 ``` r
 install.packages("pacta.multi.loanbook")
 ```
--->
 
 You can install the development version of the package from GitHub with:
 
 ``` r
+# install.packages("pak")
 pak::pak("RMI-PACTA/pacta.multi.loanbook")
 ```
 
 ## Usage
 
-Please consult the following resource for instructions on using the package. The cookbook provides a detailed overview covering the setup of the necessary software environment, obtaining and preparing input data, running the analysis, and interpreting the results.
+Please consult the following resource for instructions on using the
+package. The cookbook provides a detailed overview covering the setup of
+the necessary software environment, obtaining and preparing input data,
+running the analysis, and interpreting the results.
 
-- [Cookbook](https://rmi-pacta.github.io/pacta.multi.loanbook/articles/cookbook_overview.html): A comprehensive guide for setting up, running and interpreting the analysis.
+- [Cookbook](https://rmi-pacta.github.io/pacta.multi.loanbook//articles/cookbook_overview.html):
+  A comprehensive guide for setting up, running and interpreting the
+  analysis.
diff --git a/cran-comments.md b/cran-comments.md
@@ -0,0 +1,19 @@
+## R CMD check results
+
+❯ checking CRAN incoming feasibility ... [3s/20s] NOTE
+  Maintainer: ‘Jacob Kastl <[email protected]>’
+
+  New submission
+
+  Version contains large components (0.0.0.9000)
+
+❯ checking for future file timestamps ... NOTE
+  unable to verify current time
+
+0 errors ✔ | 0 warnings ✔ | 2 notes ✖
+
+## revdepcheck results
+
+── CHECK ───────────────────────────────────────────────────────────────────────────────────────── 0 packages ──
+OK: 0
+BROKEN: 0
diff --git a/data-raw/auxiliary_data_sets.R b/data-raw/auxiliary_data_sets.R
@@ -7,8 +7,9 @@
 # capacity by this efficiency factor to derive the physical energy input.
 # We apply such factors for fossil fuel based power generation only, since we
 # are interested in approximating the exposure to fossil fuels.
-# Values for efficiency of electricity production are taken from IEA "Energy
-# Efficiency Indicators for Public Electricity Prodcution from Fossil Fuels" at
+# Values for efficiency of electricity production (of coal, gas, and oil-fired
+# power generation are taken from IEA "Energy Efficiency Indicators for Public
+# Electricity Prodcution from Fossil Fuels" at
 # https://iea.blob.core.windows.net/assets/acaecb98-4430-4395-a4fa-d1a4d5ccb3d3/EnergyEfficiencyIndicatorsforPublicElectricityProductionfromFossilFuels.pdf
 # last accessed on 15 March, 2023.
 
@@ -21,7 +22,7 @@ primary_energy_efficiency <- dplyr::tribble(
   "global", "power",    "nuclearcap",                                 1,
   "global", "power", "renewablescap",                                 1
 )
-
+# Source: IEA (2008) Energy Efficiency Indicators for Public Electricity Production From Fossil Fuels. All rights reserved.
 
 # unit conversions -------------------------------------------------------------
 
@@ -34,7 +35,7 @@ unit_conversion <- dplyr::tribble(
   "oil and gas", "GJ",              2.3885e-08,
   "power",       "MWh",             8.598e-08
 )
-
+# Source: IEA (2023) World Energy Balances Database documentation. All rights reserved.
 
 # activity units ---------------------------------------------------------------
 

diff --git a/vignettes/cookbook_preparatory_steps.Rmd b/vignettes/cookbook_preparatory_steps.Rmd
@@ -137,8 +137,13 @@ RStudio is an integrated development environment (IDE) for R developed by Posit.
 The `pacta.multi.loanbook` package is the main software tool that you will use to run the PACTA for Supervisors analysis.
 
 ::: {.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:
+You can install the package from the RStudio CRAN mirror by running the following command in R:
 
+<!--
+The above will be replaced with the actual CRAN link once the package is on CRAN.
+
+You can install the package from the [RStudio CRAN mirror](https://CRAN.R-project.org/package=pacta.multi.loanbook) by running the following command in R:
+-->
 ``` r
 install.packages("pacta.multi.loanbook")
 ```