fse_api: Make FSE API request

Description Usage Arguments Details Value

View source: R/fse_api.R

Description

Function makes a request to FSE data system.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
fse_api(
  query = c("aircraft", "assignments", "commodities", "Facilities", "fbos",
    "flightlogs", "group", "icao", "payments", "statistics"),
  search = c("status", "configs", "aliases", "forsale", "makemodel", "ownername",
    "registration", "key", "forsale", "monthlysummary", "monthyear", "id", "members",
    "aircraft", "fbo", "fbos", "jobsto", "jobsfrom"),
  format = c("csv", "xml"),
  ...,
  content_as = "parsed"
)

## S3 method for class 'fse_api'
print(x, ...)

Arguments

query

argument

search

argument

format

either "csv" (default) or "xml"

...

other arguments, see Details

content_as

character, passed to as argument of content

x

object returned by fse_api

Details

Requests to FSE data feeds require at least specyfying format and query URL arguments. Possible values of these arguments are specified in the synopsis. Do note that not all possible combinations make sense. Other arguments, which are feed-specific can be passed through .... See FSE feed documentation for details.

Arguments format and content_as can be used to further customize the output format.

Value

A list of class "fse_api" with the following components:

content

a data frame or xml_document, depending on the value of format argument

query

a list with query parameters used in the request

response

the result of the request, as returned by httr::GET


rfse/fse documentation built on Jan. 25, 2022, 5:54 a.m.