, CJ Yetman [aut, ctr]
, Monika Furdyna [aut,
ctr] , RMI [cph, fnd]| Title: | Run 'PACTA' on Multiple Loan Books Easily |
|---|---|
| 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. |
| Authors: | Jacob Kastl [aut, cre, ctr]
, CJ Yetman [aut, ctr]
, Monika Furdyna [aut,
ctr] , RMI [cph, fnd] |
| Maintainer: | Jacob Kastl <[email protected]> |
| License: | MIT + file LICENSE |
| Version: | 0.1.1 |
| Built: | 2025-01-09 16:38:07 UTC |
| Source: | CRAN |
analyse() runs the necessary steps to analyse the matched loan books,
producing both the outputs of the standard PACTA analysis and the outputs of
the net aggregated alignment metric, including tables and plots. Parameters
for all steps are read from a config.yml file. The function is called for
its side effects and writes the prepared and diagnosed data sets in the
directory specified by dir_analysis in the config.yml.
analyse() and analyze() are synonyms.
analyse(config) analyze(config)analyse(config) analyze(config)
config |
either a path to a config.yml file or a list of parameters |
analyse() returns NULL invisibly. The function is called for its side
effects and writes the prepared and diagnosed data sets in the directory
specified by dir_analysis in the config.yml.
## Not run: config <- "path/to/config.yml" analyse(config) ## End(Not run)## Not run: config <- "path/to/config.yml" analyse(config) ## End(Not run)
An overview of the output data sets generated by the package, their data types, and the definitions of the variables.
data_dictionarydata_dictionary
data_dictionaryName of the dataset
Name of the column
Data type of the column
Description of what the column stands for
Which values are allowed for the column
...
For more details see the help vignette:
vignette("data_dictionary", package = "pacta.multi.loanbook")
internal
initialise_default_project() sets up a default project directory, including
a project directory, a default config.yml configuration file, an input
sub-directory, and a loanbooks sub-directory.
initialise_default_project(path = "project") initialize_default_project(path = "project")initialise_default_project(path = "project") initialize_default_project(path = "project")
path |
an absolute or relative path pointing to the location you would like the project directory to be created |
initialise_default_project() returns NULL invisibly. The function is
called for its side effects of creating a default project directory at the
specified path.
## Not run: project_dir <- "path/to/project" initialise_default_project(project_dir) ## End(Not run)## Not run: project_dir <- "path/to/project" initialise_default_project(project_dir) ## End(Not run)
match_loanbooks() runs the necessary steps to match the raw input loan
books with the asset based company data (ABCD) used in the PACTA for
Supervisors analysis. Specifically, it prepares matched loan books based on
name matching or direct identifiers, depending on the configuration. The
output matched loan books need to be manually validated for further
processing. Parameters for the matching step are read from a config.yml
file and follow the options available in r2dii.match::match_name. The
function is called for its side effects and writes the prepared data sets to
the directory specified by dir_matched_loanbooks in the config.yml.
match_loanbooks(config)match_loanbooks(config)
config |
either a path to a config.yml file or a list of parameters |
match_loanbooks() returns NULL invisibly. The function is called for its
side effects and writes the prepared data sets to the directory specified by
dir_matched_loanbooks in the config.yml.
## Not run: config <- "path/to/config.yml" match_loanbooks(config) ## End(Not run)## Not run: config <- "path/to/config.yml" match_loanbooks(config) ## End(Not run)
prepare_abcd() runs the necessary steps to prepare the input data sets for
the PACTA for Supervisors analysis. Specifically it prepares the abcd_final
data set by removing inactive companies if desired. And it allows preparing
the ratios by which the exposures to counterparties are split along the
sectors. Parameters for both steps are read from a config.yml file. The
function is called for its side effects and writes the prepared data sets in
the directory specified by dir_prepared_abcd in the config.yml.
prepare_abcd(config)prepare_abcd(config)
config |
either a path to a config.yml file or a list of parameters |
prepare_abcd() returns NULL invisibly. The function is called for its
side effects and writes the prepared data sets in the directory specified by
dir_prepared_abcd in the config.yml.
## Not run: config <- "path/to/config.yml" prepare_abcd(config) ## End(Not run)## Not run: config <- "path/to/config.yml" prepare_abcd(config) ## End(Not run)
prioritise_and_diagnose() runs the necessary steps to prioritise the
matched loan books and diagnose both the match success rate and the coverage
of the real economy assets by the matched loan books. Parameters for all
steps are read from a config.yml file. The function is called for its side
effects and writes the prepared and diagnosed data sets in the directory
specified by dir_prioritized_loanbooks_and_diagnostics in the config.yml.
prioritise_and_diagnose() and prioritize_and_diagnose() are synonyms.
prioritise_and_diagnose(config) prioritize_and_diagnose(config)prioritise_and_diagnose(config) prioritize_and_diagnose(config)
config |
either a path to a config.yml file or a list of parameters |
prioritise_and_diagnose() returns NULL invisibly. The function is called
for its side effects and writes the prepared and diagnosed data sets in the
directory specified by dir_prioritized_loanbooks_and_diagnostics in the
config.yml.
## Not run: config <- "path/to/config.yml" prioritise_and_diagnose(config) ## End(Not run)## Not run: config <- "path/to/config.yml" prioritise_and_diagnose(config) ## End(Not run)