diff --git a/R/portfolio_description.R b/R/portfolio_description.R new file mode 100644 index 0000000..acac46c --- /dev/null +++ b/R/portfolio_description.R @@ -0,0 +1,14 @@ +#' Description of a generic equity or debt portfolio dataset +#' +#' A equity or debt portfolio mapped to the physical assets of financial +#' securities issuers. The PACTA methodology is applied to the mapped data to +#' produce a results file with the portfolio's relative alignment with different +#' climate scenarios for technologies in climate-relevant sectors. The portfolio +#' results include the emissions factors and the absolute and scaled production +#' associated with the portfolio's exposure to each technology in +#' climate-relevant sectors. +#' +#' @name portfolio_description +#' @aliases equity debt +#' @family generic datasets +NULL diff --git a/inst/WORDLIST b/inst/WORDLIST index 85ca841..73ef31a 100644 --- a/inst/WORDLIST +++ b/inst/WORDLIST @@ -15,5 +15,6 @@ loanbook Metaprogramming MSCI ORCID +PACTA summarise tibble diff --git a/man/ald_description.Rd b/man/ald_description.Rd index 782e0a3..00a9dfd 100644 --- a/man/ald_description.Rd +++ b/man/ald_description.Rd @@ -18,6 +18,7 @@ data_dictionary() \%>\% \link{data_dictionary}, \link{ald_demo}. Other generic datasets: -\code{\link{loanbook_description}} +\code{\link{loanbook_description}}, +\code{\link{portfolio_description}} } \concept{generic datasets} diff --git a/man/loanbook_description.Rd b/man/loanbook_description.Rd index 6e5f802..1cf9067 100644 --- a/man/loanbook_description.Rd +++ b/man/loanbook_description.Rd @@ -19,6 +19,7 @@ data_dictionary() \%>\% \link{data_dictionary} Other generic datasets: -\code{\link{ald_description}} +\code{\link{ald_description}}, +\code{\link{portfolio_description}} } \concept{generic datasets} diff --git a/man/portfolio_description.Rd b/man/portfolio_description.Rd new file mode 100644 index 0000000..8612d25 --- /dev/null +++ b/man/portfolio_description.Rd @@ -0,0 +1,22 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/portfolio_description.R +\name{portfolio_description} +\alias{portfolio_description} +\alias{equity} +\alias{debt} +\title{Description of a generic equity or debt portfolio dataset} +\description{ +A equity or debt portfolio mapped to the physical assets of financial +securities issuers. The PACTA methodology is applied to the mapped data to +produce a results file with the portfolio's relative alignment with different +climate scenarios for technologies in climate-relevant sectors. The portfolio +results include the emissions factors and the absolute and scaled production +associated with the portfolio's exposure to each technology in +climate-relevant sectors. +} +\seealso{ +Other generic datasets: +\code{\link{ald_description}}, +\code{\link{loanbook_description}} +} +\concept{generic datasets}