New portfolio_description

Closes #23 Thanks @vintented
RMI-PACTA · Dec 18, 2019 · 0e89022 · 0e89022
1 parent 61961d3
commit 0e89022
Show file tree

Hide file tree

Showing 5 changed files with 41 additions and 2 deletions.
diff --git a/R/portfolio_description.R 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
@@ -15,5 +15,6 @@ loanbook
 Metaprogramming
 MSCI
 ORCID
+PACTA
 summarise
 tibble
diff --git a/man/ald_description.Rd b/man/ald_description.Rd
diff --git a/man/loanbook_description.Rd b/man/loanbook_description.Rd
diff --git a/man/portfolio_description.Rd b/man/portfolio_description.Rd
-Original file line number
+Diff line change
@@ Expand Up / @@ -15,5 +15,6 @@ loanbook @@
     Metaprogramming
     MSCI
     ORCID
+    PACTA
     summarise
     tibble