returns: Compute absolute, relative or log returns.

View source: R/returns.R

returnsR Documentation

Compute absolute, relative or log returns.

Description

Computes periodic returns from a dataframe ordered by date

Usage

returns(df = dflong, retType = "abs", period.return = 1, spread = FALSE)

Arguments

df

Long dataframe with colnames = c("date","value","series")

retType

"abs" for absolute, "rel" for relative, or "log" for log returns.

period.return

Number of rows over which to compute returns.

spread

TRUE if you want to spread into a long dataframe.

Value

A dataframe object of returns.

Author(s)

Philippe Cote

Examples

x <- dflong %>% dplyr::filter(grepl("CL01", series))
returns(df = x, retType = "abs", period.return = 1, spread = TRUE)

RTL documentation built on June 17, 2022, 5:06 p.m.