eu_non_eu_total: Function accesses the Stat-Xplore API and returns data...

In DFoly/ninorap: What the Package Does (One Line, Title Case)

Description

Function accesses the Stat-Xplore API and returns data relating to Nino Registrations from the EU and outside the EU. This data is used to construct a time series graph of these registrations over time.

Usage

eu_non_eu_total(start_date, end_date, frequency, get_countries = FALSE,
  verbose = FALSE, apiKey = NULL)

Arguments

start_date	start date of data we want: month must be one of 3,6,9,12 so "2017-03-01" is valid "2017-01-01" is not
end_date	what date do we want data until
frequency	One of quarter, month, annual
get_countries	if TRUE will get all nationalities, used for top 5 table in publication.
verbose	if true, it will return information sent to the Stat-Xplore server.
apiKey	apiKey for stat-xplore: you will need to create an account to generate a key

Value

class containing data and other attributes useful for plotting

Source

https://stat-xplore.dwp.gov.uk/webapi/jsf/login.xhtml

Examples

## Not run: eu_non_eu_total("2002-03-01", "2018-12-01", "quarter", 3, TRUE)

DFoly/ninorap documentation built on Aug. 15, 2019, 12:52 a.m.