Export functions (#84)

DESCRIPTION

@@ -1,6 +1,6 @@
 Package: workflow.pacta
 Title: Run PACTA
-Version: 0.0.0.9007
+Version: 0.0.0.9008
 Authors@R: 
     c(person(given = "CJ",
              family = "Yetman",

NAMESPACE

@@ -1,5 +1,9 @@
 # Generated by roxygen2: do not edit by hand
 
+export(calc_weights_and_outputs)
+export(run_analysis)
+export(run_audit)
+export(run_pacta)
 importFrom(logger,log_debug)
 importFrom(logger,log_error)
 importFrom(logger,log_info)

R/calc_weights_and_outputs.R

@@ -1,3 +1,26 @@
+#' calc_weights_and_outputs
+#'
+#' @description This function calculates the weights and outputs for the
+#' portfolio. This is the core of running the "PACTA analysis" for a portfolio.
+#'
+#' @param total_portfolio `data.frame`: PACTA formatted portfolio.
+#' @param portfolio_type `character`: Portfolio type. Accepts "Equity" or
+#' "Bonds".
+#' @param output_dir filepath: Directory to save outputs.
+#' @param data_dir filepath: Directory with "pacta-data"
+#' @param equity_market_list character vector: List of equity markets to
+#' include in analysis.
+#' @param scenario_sources_list character vector: List of scenario sources to
+#' include in analysis. Note sources must be available in the "pacta-data".
+#' @param scenario_geographies_list character vector: List of scenario-defined
+#' geographies to include in analysis. Note these geographies must be available
+#' in the scenario data.
+#' @param sector_list character vector: List of sectors to include in analysis.
+#' @param start_year integer: Start year for analysis.
+#' @param time_horizon integer: Time horizon after start for analysis (usually
+#' 5 years).
+#' @return No return value. Saves outputs to output_dir.
+#' @export
 calc_weights_and_outputs <- function(
   total_portfolio,
   portfolio_type,

R/run_analysis.R

@@ -1,3 +1,22 @@
+#' @title run_analysis
+#'
+#' @description This function runs the PACTA analysis for a portfolio.
+#'
+#' @param pacta_data_dir filepath: Directory with "pacta-data"
+#' @param output_dir filepath: Directory to save outputs.
+#' @param equity_market_list character vector: List of equity markets to
+#' include in analysis.
+#' @param scenario_sources_list character vector: List of scenario sources to
+#' include in analysis. Note sources must be available in the "pacta-data".
+#' @param scenario_geographies_list character vector: List of scenario-defined
+#' geographies to include in analysis. Note these geographies must be available
+#' in the scenario data.
+#' @param sector_list character vector: List of sectors to include in analysis.
+#' @param start_year integer: Start year for analysis.
+#' @param time_horizon integer: Time horizon after start for analysis (usually
+#' 5 years).
+#' @return No return value. Saves outputs to output_dir.
+#' @export
 run_analysis <- function(
   pacta_data_dir,
   output_dir,

R/run_audit.R

@@ -1,3 +1,13 @@
+#' @title run_audit
+#'
+#' @description This function runs the PACTA audit for a portfolio.
+#'
+#' @param pacta_data_dir filepath: Directory with "pacta-data"
+#' @param portfolio_dir filepath: Directory with portfolio files
+#' @param portfolio_files character vector: List of portfolio files to process.
+#' @param output_dir filepath: Directory to save outputs.
+#' @return No return value. Saves outputs to output_dir.
+#' @export
 run_audit <- function(
   pacta_data_dir,
   portfolio_dir,

R/run_pacta.R

@@ -1,3 +1,13 @@
+#' @title Run PACTA
+#'
+#' @description This function runs the PACTA audit and analysis for a portfolio.
+#'
+#' @param raw_params character or filepath: JSON string or file with parameters.
+#' @param pacta_data_dir filepath: Directory with "pacta-data"
+#' @param output_dir filepath: Directory to save outputs.
+#' @param portfolio_dir filepath: Directory with portfolio files
+#' @return No return value. Saves outputs to output_dir.
+#' @export
 run_pacta <- function(
   raw_params = commandArgs(trailingOnly = TRUE),
   pacta_data_dir = Sys.getenv("PACTA_DATA_DIR"),