Package 'pacta.portfolio.allocate'

Title: pacta.portfolio.allocate
Description: For more information visit <https://rmi.org/>.
Authors: CJ Yetman [aut, cre, ctr] , Jackson Hoffart [aut, ctr] , Jacob Kastl [aut, ctr], Alex Axthelm [aut, ctr] , RMI [cph, fnd]
Maintainer: CJ Yetman <[email protected]>
License: MIT + file LICENSE
Version: 0.0.2.9000
Built: 2024-10-30 12:24:02 UTC
Source: https://github.com/rmi-pacta/pacta.portfolio.allocate

Help Index


A short description of the function

Description

A longer description of the function

Usage

aggregate_company(df)

Arguments

df

A description of the argument

Value

A description of the return value


A short description of the function

Description

A longer description of the function

Usage

aggregate_map_data(portfolio)

Arguments

portfolio

A description of the argument

Value

A description of the return value


A short description of the function

Description

A longer description of the function

Usage

aggregate_portfolio(df)

Arguments

df

A description of the argument

Value

A description of the return value


A short description of the function

Description

A longer description of the function

Usage

calculate_scenario_alignment(df)

Arguments

df

A description of the argument

Value

A description of the return value


A short description of the function

Description

A longer description of the function

Usage

calculate_technology_share(df)

Arguments

df

A description of the argument

Value

A description of the return value


A short description of the function

Description

A longer description of the function

Usage

calculate_weights(portfolio, portfolio_type, ...)

Arguments

portfolio

A description of the argument

portfolio_type

A description of the argument

...

A catch-all for deprecated variables (e.g. grouping_variables)

Value

A description of the return value


A short description of the function

Description

A longer description of the function

Usage

create_portfolio_subset(portfolio, portfolio_type, ...)

Arguments

portfolio

A description of the argument

portfolio_type

A description of the argument

...

A catch-all for deprecated variables (e.g. grouping_variables)

Value

A description of the return value


A short description of the function

Description

A longer description of the function

Usage

get_abcd_raw(
  portfolio_type,
  analysis_inputs_path,
  start_year,
  time_horizon,
  sector_list
)

Arguments

portfolio_type

A description of the argument

analysis_inputs_path

Path to directory containing ABCD Data files

start_year

Start year of the analysis

time_horizon

Length of the analysis in years (analysis will run from start_year to start_year + time_horizon)

sector_list

(character) A vector of PACTA sectors to include in the analysis.

Value

A description of the return value


Merge ABCD_scenario data from a database file (RDS or SQLite) with the portfolio data

Description

Merge ABCD_scenario data from a database file (RDS or SQLite) with the portfolio data

Usage

merge_abcd_from_db(
  portfolio,
  portfolio_type,
  db_dir,
  equity_market_list,
  scenario_sources_list,
  scenario_geographies_list,
  sector_list,
  id_col = "id"
)

Arguments

portfolio

A data frame containing the processed portfolio data

portfolio_type

A single string specifying the type of assets in the portfolio

db_dir

A single string specifying the path to the directory that contains the database file

equity_market_list

A character vector of equity markets to be included

scenario_sources_list

A character vector of scenario sources to be included

scenario_geographies_list

A character vector of senario geographies to be included

sector_list

A character vector of sectors to be included

id_col

A single string specifying the name of the id column in the portfolio data

Value

A data frame contianing the portfolio data with the merged ABCD_scenario data


A short description of the function

Description

A longer description of the function

Usage

merge_in_geography(portfolio, ald_raw, sector_list)

Arguments

portfolio

A description of the argument

ald_raw

A description of the argument

sector_list

(character) A vector of PACTA sectors to include in the analysis.

Value

A description of the return value


A short description of the function

Description

A longer description of the function

Usage

ownership_allocation(portfolio)

Arguments

portfolio

A description of the argument

Value

A description of the return value


A short description of the function

Description

A longer description of the function

Usage

port_weight_allocation(port_abcd)

Arguments

port_abcd

A description of the argument

Value

A description of the return value


A short description of the function

Description

A longer description of the function

Usage

pw_calculations(eq_portfolio, cb_portfolio, ...)

Arguments

eq_portfolio

A description of the argument

cb_portfolio

A description of the argument

...

A catch-all for deprecated variables (e.g. grouping_variables)

Value

A description of the return value