Skip to content

Commit

Permalink
Document and export prep_exposure_pie
Browse files Browse the repository at this point in the history
  • Loading branch information
AlexAxthelm committed Dec 19, 2024
1 parent 769cdbe commit 880f6a4
Show file tree
Hide file tree
Showing 3 changed files with 51 additions and 0 deletions.
1 change: 1 addition & 0 deletions NAMESPACE
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# Generated by roxygen2: do not edit by hand

export(prep_company_bubble)
export(prep_exposure_pie)
export(prep_exposure_stats)
export(prep_key_bars_company)
export(prep_key_bars_portfolio)
Expand Down
14 changes: 14 additions & 0 deletions R/prep_exposure_pie.R
Original file line number Diff line number Diff line change
@@ -1,3 +1,17 @@
#' Prepare data for exposure pie chart
#'
#' Prepare JSON data for the exposure pie chart.
#'
#' @param (data.frame) Audit file contents
#' @param asset_type (character scalar) Asset type (`Equity` or `Bonds`)
#' @param investor_name (character scalar) Investor name
#' @param portfolio_name (character scalar) Portfolio name
#' @param pacta_sectors (character vector) PACTA sectors
#' @param currency_exchange_value (numeric scalar) Currency exchange value to
#' convert to USD
#' @return (data.frame) suitible for serialization to JSON (using
#' `jsonlite::toJSON`/`jsonlite::write_json`)
#' @export
prep_exposure_pie <-
function(data,
asset_type,
Expand Down
36 changes: 36 additions & 0 deletions man/prep_exposure_pie.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 880f6a4

Please sign in to comment.