get_scores: Get Document Scores from the Prattle API

In prattle-analytics/pRattle: What the package does (short line)

Description

Primary R function for gathering document scores.

Usage

get_scores(bank = "frc", type = "xts", email = NULL, pwd = NULL,
  agg.level = "raw", add.extra = TRUE, ssl_workaround = FALSE)

Arguments

bank	: A string vector that matches a central bank shorthand code.
type	: Defaults to an xts data frame.
email	: A string vector with an email for portal login
pwd	: A string vector with a password for portal login
agg.level	: Level of aggregation for the data. Default is raw scores. Can be "daily" or "weekly".
ssl_workaround	: Rarely used option for users with SSL certification issues. Can be "True", or "False".

Value

Dataframe. By default, xts/zoo type.

Examples

head(get_scores('frc', email = '<YOUR EMAIL>', pwd = '<YOUR PASSWORD>'))

prattle-analytics/pRattle documentation built on May 25, 2019, 11:26 a.m.