call_naptan {naptanr}R Documentation

Call the NaPTAN API for all, or for specified ATCO codes. Returns a data frame of Naptan data.

Description

Call the NaPTAN API for all, or for specified ATCO codes. Returns a data frame of Naptan data.

Usage

call_naptan(atco = NULL)

Arguments

atco

string or vector of strings. First three digits of ATCO area codes of interest. If provided, will return data for only these ATCO areas. Defaults to NULL.

To return a lookup of current valid ATCO codes, use the lookup_atco_codes() function.

Value

Returns a data frame of NaPTAN data containing transport access node information. See NaPTAN data set guidance for more information.

Examples


## Not run: 
#Return data for all ATCO areas 
call_naptan()

#Return data for a single ATCO area
call_naptan(atco = "050")

#Return data for multiple atco codes
call_naptan(atco = c("050", "290")) 


## End(Not run)

[Package naptanr version 1.0.1 Index]