elexonData: elexonData

Description Usage Arguments Examples

View source: R/elexonData.R

Description

This function pulls data from Elexon/BMRS, given a user's key, start and end dates and the dataset in question. Please note: it does not matter if BMRS requires the dates to be in a different format to "yyyy-mm-dd". The Relexon package will take care of this. Just enter the dates in the usual format!

Usage

1
2
elexonData(dataset = "ROLSYSDEM", key, from = Sys.Date() - 2,
  to = Sys.Date() - 1, test = FALSE)

Arguments

dataset

The dataset you are pulling from BMRS/Elexon.

key

Your personal scripting key from elexon. Find out more at https://www.elexonportal.co.uk

from

This is the start date/datetime of the dataset.

to

This is the end date/datetime of the dataset.

test

This is set to FALSE by default. Set this argument to TRUE if you want to use the test version of the API. It comes in handy if you are pulling the same datasets repeatedly without getting warnings from Elexon.

Examples

1
2
3
4
5
6
7
8
9
## Not run: 
elexonData(
"ROLSYSDEM",
key = "948ghmgpe",
from = "2018-01-01",
test = TRUE
)

## End(Not run)

Relexon documentation built on Nov. 20, 2019, 1:08 a.m.

Related to elexonData in Relexon...