Skip to content

Commit

Permalink
notes on implementation in docs (#6)
Browse files Browse the repository at this point in the history
  • Loading branch information
simonpcouch committed May 1, 2020
1 parent 2d789ab commit c58d0af
Show file tree
Hide file tree
Showing 4 changed files with 27 additions and 0 deletions.
7 changes: 7 additions & 0 deletions R/anyflights.R
Expand Up @@ -18,6 +18,13 @@
#' airport in a given year and month
#' }
#'
#' The recommended approach to download data for many stations (airports)
#' is to supply a vector of stations to the \code{station} argument rather than
#' iterating over many calls to \code{anyflights()}. The \code{faa} column
#' in dataframes outputted by \code{get_airports()} provides the FAA LID
#' codes for all supported airports. See
#' ?\code{\link{get_flights}} for more details on implementation.
#'
#' @param station A character vector giving the origin US airports of interest
#' (as the FAA LID airport code).
#'
Expand Down
6 changes: 6 additions & 0 deletions R/get_flights.R
Expand Up @@ -6,6 +6,12 @@
#' note that, even with a strong internet connection, this function
#' may take several minutes to download relevant data.
#'
#' This function currently downloads data for \emph{all} stations for each month
#' supplied, and \emph{then} filters out data for relevant stations. Thus,
#' the recommended approach to download data for many airports is to supply
#' a vector of airport codes to the \code{station} argument rather than
#' iterating over many calls to \code{get_flights()}.
#'
#' @inheritParams anyflights
#'
#' @param ... Currently only used internally.
Expand Down
7 changes: 7 additions & 0 deletions man/anyflights.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

7 changes: 7 additions & 0 deletions man/get_flights.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit c58d0af

Please sign in to comment.