exist_attribute_correlations: Query Exist.io for all correlations for a specific attribute

Description Usage Arguments Value Examples

View source: R/exist_attribute_correlations.R

Description

Returns information on all correlations for a specific attribute.

Usage

1
2
3
4
5
6
7
8
9
exist_attribute_correlations(
  token = NULL,
  attribute = "mood",
  limit = NULL,
  page = 1,
  date_min = NULL,
  date_max = NULL,
  latest = NULL
)

Arguments

token

The token environment.

attribute

The attribute for which to get all correlations. Defaults to mood.

limit

Number of values to return per page, starting with today. Optional, max is 100.

page

Page index. Optional, default is 1.

date_min

Oldest date (inclusive) of results to be returned, in format YYYY-mm-dd. Optional.

date_max

Most recent date (inclusive) of results to be returned, in format YYYY-mm-dd. Optional.

latest

Set this to true to return only the most recently generated batch of correlations. Use this on its own without date_min and date_max.

Value

A list containing the information of all correlations for a specific attribute.

Examples

1
2
3
4
5
## Not run: 
etoken <- exist_auth()
exist_attribute_correlations(etoken)

## End(Not run)

ebbertd/existR documentation built on March 3, 2020, 8:02 a.m.