add pacta.data.preparation and pacta.scenario.data.preparation (#48)

RMI-PACTA · Nov 29, 2024 · 4284af4 · 4284af4
1 parent 75a812d
commit 4284af4
Show file tree

Hide file tree

Showing 9 changed files with 33 additions and 8 deletions.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -39,6 +39,7 @@ Imports:
     dplyr,
     magrittr,
     pacta.data.scraping (>= 0.0.0.9000),
+    pacta.data.preparation (>= 0.1.0.9003),
     pacta.data.validation (>= 0.0.0.9000),
     pacta.executive.summary (>= 0.0.1.9000),
     pacta.interactive.plot (>= 0.0.0.9000),
@@ -47,20 +48,23 @@ Imports:
     pacta.portfolio.import (>= 0.0.0.9000),
     pacta.portfolio.report (>= 0.0.1.9000),
     pacta.portfolio.utils (>= 0.0.1.9000),
+    pacta.scenario.data.preparation (>= 0.0.0.9000),
     purrr,
     rlang,
     rstudioapi,
     tibble
 Remotes: 
     RMI-PACTA/pacta.data.scraping,
+    RMI-PACTA/pacta.data.preparation,
     RMI-PACTA/pacta.data.validation,
     RMI-PACTA/pacta.executive.summary,
     RMI-PACTA/pacta.interactive.plot,
     RMI-PACTA/pacta.portfolio.allocate,
     RMI-PACTA/pacta.portfolio.audit,
     RMI-PACTA/pacta.portfolio.import,
     RMI-PACTA/pacta.portfolio.report,
-    RMI-PACTA/pacta.portfolio.utils
+    RMI-PACTA/pacta.portfolio.utils,
+    RMI-PACTA/pacta.scenario.data.preparation
 Suggests: 
     covr,
     DT,

diff --git a/R/attach.R b/R/attach.R
@@ -1,13 +1,15 @@
 core <- c(
   "pacta.data.scraping",
+  "pacta.data.preparation",
   "pacta.portfolio.import",
   "pacta.data.validation",
   "pacta.portfolio.allocate",
   "pacta.portfolio.audit",
   "pacta.portfolio.report",
   "pacta.portfolio.utils",
   "pacta.executive.summary",
-  "pacta.interactive.plot"
+  "pacta.interactive.plot",
+  "pacta.scenario.data.preparation"
   )
 
 core_unloaded <- function() {

diff --git a/R/pactaverse.R b/R/pactaverse.R
@@ -6,6 +6,7 @@
 #   All declared Imports should be used.
 ignore_unused_imports <- function() {
   pacta.data.scraping::get_currency_exchange_rates
+  pacta.data.preparation::calc_shares_all_classes
   pacta.portfolio.import::determine_headers
   pacta.data.validation::fake_abcd_flags_bonds
   pacta.portfolio.allocate::aggregate_company
@@ -14,6 +15,7 @@ ignore_unused_imports <- function() {
   pacta.portfolio.utils::abort_if_file_doesnt_exist
   pacta.executive.summary::alignment_scores_values
   pacta.interactive.plot::as_exposure_map_data
+  pacta.scenario.data.preparation::add_market_share_columns
 }
 
 release_bullets <- function() {

diff --git a/README.Rmd b/README.Rmd
@@ -45,6 +45,7 @@ If you're compiling from source, you can run `pak::pkg_system_requirements("pact
 `library(pactaverse)` will load the core pactaverse packages: 
 
 * [pacta.data.scraping](https://rmi-pacta.github.io/pacta.data.scraping/), for scraping public datasets (e.g. currencies, or indices).
+* [pacta.data.preparation](https://rmi-pacta.github.io/pacta.data.preparation/), for preparing input datasets (e.g. ABCD).
 * [pacta.portfolio.import](https://rmi-pacta.github.io/pacta.portfolio.import/), for facilitating the import of financial portfolios.
 * [pacta.data.validation](https://rmi-pacta.github.io/pacta.data.validation/), for validating all PACTA input datasets.
 * [pacta.portfolio.allocate](https://rmi-pacta.github.io/pacta.portfolio.allocate/), for merging portfolios with ABCD and scenario data, and allocating target weights.
@@ -53,6 +54,7 @@ If you're compiling from source, you can run `pak::pkg_system_requirements("pact
 * [pacta.portfolio.utils](https://rmi-pacta.github.io/pacta.portfolio.utils/), for general utility functions, especially those that support transition monitor.
 * [pacta.executive.summary](https://rmi-pacta.github.io/pacta.executive.summary/), for generating executive summaries for COP projects.
 * [pacta.interactive.plot](https://rmi-pacta.github.io/pacta.interactive.plot/), for generating interactive plots of PACTA results.
+* [pacta.scenario.data.preparation](https://rmi-pacta.github.io/pacta.scenario.data.preparation/), for preparing scenario data.
 
 ## Code of Conduct
 

diff --git a/README.md b/README.md
@@ -42,6 +42,8 @@ system packages needed on your machine.
 
 - [pacta.data.scraping](https://rmi-pacta.github.io/pacta.data.scraping/),
   for scraping public datasets (e.g. currencies, or indices).
+- [pacta.data.preparation](https://rmi-pacta.github.io/pacta.data.preparation/),
+  for preparing input datasets (e.g. ABCD).
 - [pacta.portfolio.import](https://rmi-pacta.github.io/pacta.portfolio.import/),
   for facilitating the import of financial portfolios.
 - [pacta.data.validation](https://rmi-pacta.github.io/pacta.data.validation/),
@@ -60,6 +62,8 @@ system packages needed on your machine.
   for generating executive summaries for COP projects.
 - [pacta.interactive.plot](https://rmi-pacta.github.io/pacta.interactive.plot/),
   for generating interactive plots of PACTA results.
+- [pacta.scenario.data.preparation](https://rmi-pacta.github.io/pacta.scenario.data.preparation/),
+  for preparing scenario data.
 
 ## Code of Conduct
 

diff --git a/_pkgdown.yml b/_pkgdown.yml
@@ -14,6 +14,8 @@ navbar:
       - text: -----
       - text: "pacta.data.scraping"
         href: https://rmi-pacta.github.io/pacta.data.scraping/
+      - text: "pacta.data.preparation"
+        href: https://rmi-pacta.github.io/pacta.data.preparation/
       - text: "pacta.portfolio.import"
         href: https://rmi-pacta.github.io/pacta.portfolio.import/
       - text: "pacta.data.validation"
@@ -30,6 +32,8 @@ navbar:
         href: https://rmi-pacta.github.io/pacta.executive.summary/
       - text: "pacta.interactive.plot"
         href: https://rmi-pacta.github.io/pacta.interactive.plot/
+      - text: "pacta.scenario.data.preparation"
+        href: https://rmi-pacta.github.io/pacta.scenario.data.preparation/
     methodology:
       text: "Methodology"
       menu:

diff --git a/tests/testthat/_snaps/attach.md b/tests/testthat/_snaps/attach.md
@@ -9,11 +9,12 @@
       cat(pactaverse_attach_message(core))
     Output
       -- Attaching core pactaverse packages ---------------------- pactaverse 1.0.0 --
-      v pacta.data.scraping      1.0.0     v pacta.portfolio.audit    1.0.0
-      v pacta.data.validation    1.0.0     v pacta.portfolio.import   1.0.0
-      v pacta.executive.summary  1.0.0     v pacta.portfolio.report   1.0.0
-      v pacta.interactive.plot   1.0.0     v pacta.portfolio.utils    1.0.0
-      v pacta.portfolio.allocate 1.0.0     
+      v pacta.data.preparation          1.0.0     v pacta.portfolio.audit           1.0.0
+      v pacta.data.scraping             1.0.0     v pacta.portfolio.import          1.0.0
+      v pacta.data.validation           1.0.0     v pacta.portfolio.report          1.0.0
+      v pacta.executive.summary         1.0.0     v pacta.portfolio.utils           1.0.0
+      v pacta.interactive.plot          1.0.0     v pacta.scenario.data.preparation 1.0.0
+      v pacta.portfolio.allocate        1.0.0     
 
 # highlights dev versions in red
 

diff --git a/vignettes/articles/global-search.Rmd b/vignettes/articles/global-search.Rmd
@@ -12,6 +12,7 @@ knitr::opts_chunk$set(
 
 ```{r setup, message=FALSE}
 library(pacta.data.scraping)
+library(pacta.data.preparation)
 library(pacta.data.validation)
 library(pacta.executive.summary)
 library(pacta.interactive.plot)
@@ -20,19 +21,22 @@ library(pacta.portfolio.audit)
 library(pacta.portfolio.import)
 library(pacta.portfolio.report)
 library(pacta.portfolio.utils)
+library(pacta.scenario.data.preparation)
 ```
 
 ```{r}
 packages <- c(
   "pacta.data.scraping",
+  "pacta.data.preparation",
   "pacta.data.validation",
   "pacta.executive.summary",
   "pacta.interactive.plot",
   "pacta.portfolio.allocate",
   "pacta.portfolio.audit",
   "pacta.portfolio.import",
   "pacta.portfolio.report",
-  "pacta.portfolio.utils"
+  "pacta.portfolio.utils",
+  "pacta.scenario.data.preparation"
 )
 
 url_template <- "https://rmi-pacta.github.io/{package}/reference/{topic}.html"