getGenscapePipeOil: 'getGenscapePipeOil'

Description Usage Arguments Value Author(s) Examples

View source: R/genscape.R

Description

Returns oil pipeline flows in barrels per day data from Genscape API.You need your own credentials. Refer to API documentation for argument values. It is assumed if you use this function that you know the pipelines you need to extract to build supply demand balances. Use the online API to identify the pipeline IDs. https://developer.genscape.com/docs/services/oil-transportation/operations/GetPipelineFlowValuesV2/

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
getGenscapePipeOil(
  frequency = "daily",
  regions = "Canada",
  pipelineIDs = c(97),
  revision = "revised",
  limit = 5000,
  offset = 0,
  startDate = "2015-01-01",
  endDate = as.character(Sys.Date()),
  apikey = "yourapikey"
)

Arguments

frequency

"daily" DEFAULT.

regions

See API webpage. Multiple values separated by commas e.g. "Canada", "GulfCoast").

pipelineIDs

See API webpage. c(98,54...) for specific pipes.

revision

See API webpage.

limit

See API webpage. Max 5000

offset

See API webpage.

startDate

"yyyy-mm-dd" as character string

endDate

"yyyy-mm-dd" as character string

apikey

Your API key as a character string.

Value

wide data frame

Author(s)

Philippe Cote

Examples

1
2
3
4
5
6
7
## Not run: 
getGenscapePipeOil(frequency = "daily", regions = "Canada",pipelineIDs = c(97),
                  revision = "revised", limit = 5000, offset = 0,
                  startDate = "2015-01-01", endDate = as.character(Sys.Date()),
                  apikey = "yourapikey")

## End(Not run)

RTL documentation built on June 12, 2021, 5:06 p.m.