Pmetar is an R package that allows to download and parse current or historical METAR (Meteorological Terminal Aviation Routine Weather Report) reports, mainly for airports.
It has to be underlined that the package pmetar is not intended for flight planning or navigation.
For downloading a METAR report we need to know an airport four
letters ICAO code, International Civil Aviation Organization, or three
letters IATA code, International Air Transport Association.
Let’s download a current METAR weather report for Warsaw Okecie Airport.
Its ICAO, International Civil Aviation Organization, code is EPWA. A
report can be got from Aviation Weather Center https://www.aviationweather.gov/metar
library(dplyr)
#>
#> Attaching package: 'dplyr'
#> The following objects are masked from 'package:stats':
#>
#> filter, lag
#> The following objects are masked from 'package:base':
#>
#> intersect, setdiff, setequal, union
library(pmetar)
metar_get("EPWA")
#> Getting airport informaiton from the file downloaded from
#> http://ourairports.com/data/airports.csv
#> Getting information from Aviation Weather Center www.aviationweather.gov/metar
#> Don't use for flight planning or navigation!
#> [1] "EPWA 292000Z 25007KT CAVOK 17/13 Q1017 NOSIG"Now let’s take a look at Newark Liberty International Airport, EWR IATA code. This type of code you find on your airplane tickets.
metar_get("EWR")
#> Getting airport informaiton from the file downloaded from
#> http://ourairports.com/data/airports.csv
#> Getting information from Aviation Weather Center www.aviationweather.gov/metar
#> Don't use for flight planning or navigation!
#> [1] "KEWR 291951Z 13010G17KT 10SM FEW040 FEW050 29/21 A3004 RMK AO2 SLP173 T02940206"The above message is intended for professionals like pilots or air traffic controllers. The first purpose of preparing the pmetar package was the need of extracting wind speed and air pressure values from METAR reports for some airports in Poland. Later the package functionality was extended. We will go through the main functions with a historical METAR report from John F. Kennedy International Airport.
The function metar_get_historical allows to download METAR weather reports for a defined period of time. The default online source of METAR reports, from = “iastate” is the Iowa Environmental Mesonet web page of Iowa State University ASOS-AWOS-METAR http://mesonet.agron.iastate.edu/AWOS/.
dm <- metar_get_historical("JFK", start_date = "2020-06-27", end_date = "2020-06-29", from = "iastate")head(dm)
#> [1] "202006270000 METAR KJFK 270000Z AUTO 19007KT 10SM CLR 23/18 A2990 RMK T02300180 MADISHF"
#> [2] "202006270005 METAR KJFK 270005Z AUTO 19008KT 10SM CLR 24/18 A2990 RMK T02400180 MADISHF"
#> [3] "202006270010 METAR KJFK 270010Z AUTO 20008KT 10SM CLR 24/18 A2990 RMK T02400180 MADISHF"
#> [4] "202006270015 METAR KJFK 270015Z AUTO 21005KT 10SM FEW110 24/18 A2990 RMK T02400180 MADISHF"
#> [5] "202006270020 METAR KJFK 270020Z AUTO 21005KT 10SM SCT110 24/18 A2990 RMK T02400180 MADISHF"
#> [6] "202006270025 METAR KJFK 270025Z AUTO 23008KT 10SM SCT110 24/17 A2990 RMK T02400170 MADISHF"The second backup source, from = “ogimet” is Weather Information Service provided by Ogimet http://www.ogimet.com/. Please take into consideration that Ogimet usually blocks too frequent requests for data due to the server overload, the requested period is limited to 31 days and for the most of airports METAR reports are available from the beginning of the year 2005.
metar_get_historical("JFK", start_date = "2020-06-27", end_date = "2020-06-29", from = "ogimet")In the package version from 0.4.0 it is possible to check the syntax of downloaded METAR reports with the function metar_is_correct(). Also in several functions the additional parameter check was implemented. The default value is TRUE. If it is set to FALSE decoding of METAR reports should work as in the previouse package versions.
metar_is_correct(dm[1:5])
#> [1] TRUE TRUE TRUE TRUE TRUELet’s one report with incorrect one and check how it works.
dc <- c(dm[1:5],
"202006261625 SPEC KJFK 261625Z AUTO 28009KT 10SM CLR 30/12 A2995 RMK T03000120")
metar_is_correct(dc)
#> [1] TRUE TRUE TRUE TRUE TRUE FALSEIt is possible to select incorrect reports from input.
dc[!metar_is_correct(dc)]
#> [1] "202006261625 SPEC KJFK 261625Z AUTO 28009KT 10SM CLR 30/12 A2995 RMK T03000120"The function has the parameter verbose which helps to identify incorrect reports. The index and the incorrect METAR are displayed
metar_is_correct(dc, verbose = TRUE)
#> Incorrect METAR report:
#> 6 202006261625 SPEC KJFK 261625Z AUTO 28009KT 10SM CLR 30/12 A2995The check of syntax was implemented in the following functions, however it must be enabled by setting check = TRUE. Only in the function metar_decode() it is set to TRUE by default.
We will parse the last report from the above dm. In historical reports dates and hours are placed at the beginning of texts. Normally it’s extracted and parsed, but for now let’s remove it
(dm[length(dm)])
#> [1] "202006270025 METAR KJFK 270025Z AUTO 23008KT 10SM SCT110 24/17 A2990 RMK T02400170 MADISHF"
my_report <- substr(dm[length(dm)], 14, nchar(dm[length(dm)]))
my_report
#> [1] "METAR KJFK 270025Z AUTO 23008KT 10SM SCT110 24/17 A2990 RMK T02400170 MADISHF"It has to be noted that the report part after the RMK, remarks, is not analyzed, except the temperature information, which is provide more precisely in remarks.
The first element METAR indicates the text consist of a METAR weather report. If a report was issued under special circumstances, a text SPECI replaces METAR.
The second four letters element, KJFK identifies an airport from which a METAR issued. We can extract it
metar_airport(my_report)
#> [1] "KJFK"and find the KJFK geographical coordinates, elevation, airport IATA code, airport name and source of information.
metar_location(metar_airport(my_report))
#> Getting airport informaiton from the file downloaded from
#> https://ourairports.com/data/
#> created by David Megginson
#> # A tibble: 1 × 7
#> ICAO_Code IATA_Code Airport_Name Longi…¹ Latit…² Eleva…³ Source
#> <chr> <chr> <chr> <dbl> <dbl> <dbl> <chr>
#> 1 KJFK JFK John F Kennedy Internation… -73.8 40.6 3.96 http:…
#> # … with abbreviated variable names ¹Longitude, ²Latitude, ³ElevationThe third element 282355Z includes a day of a month, a time and a time zone.
metar_day(my_report)
#> [1] 27
metar_hour(my_report)
#> [1] "00:25"
metar_time_zone(my_report)
#> [1] "Z"The fourth element, in our case AUTO informs that a report was generated automatically. If a report was manually corrected it is COR. This element is not taken into consideration by the package pmetar.
Next, there is the text 07007KT where three first digits informs about a wind direction in degrees. Two next digits are a wind speed and the letters the end define units, here KT, hence a wind speed is in knots.
metar_dir(my_report)
#> [1] "230"
metar_speed(my_report, metric = TRUE)
#> [1] 4.115558
metar_speed(my_report, metric = FALSE)
#> [1] 8The function metar_speed reports a wind speed in m/s with the default
value of the parameter metric = TRUE, or in knots when
metric = FALSE.
When a wind direction varies, a METAR report has additional component,
like 140V200, which informs that a wind direction
fluctuates from 140 to 200 degrees.
variable_direction_METAR <- "EPWA 281830Z 18009KT 140V200 9999 SCT037 03/M01 Q1008 NOSIG"
metar_dir(variable_direction_METAR)
#> [1] "180; variable from 140 to 200"In this case an output is character what can be useless for statistical calculations. If only main direction in the numeric format is needed, it is possible to set the parameter numeric_only = TRUE.
metar_dir(variable_direction_METAR, numeric_only = TRUE)
#> [1] 180The part 10SM is the visibility. In this case it’s 10 statue miles. With the default value of the paremeter metric= TRUE we get output in meters. For metric = FALSE in statute miles.
metar_visibility(my_report, metric = TRUE)
#> [1] "16093.44"
metar_visibility(my_report, metric = FALSE)
#> [1] "10"The function metar_wx_codes() extracts and parses the below weather
conditions codes.
In the package version 0.4.0 the parameter sep with the default
value “;” was introduce. It allows to avoid problems with saving output
in .csv files. Two values are allowed, comma and semicolon. If you need
to get the function output separated by commas just set sep =
“,”.
metarWXcodes
#> Type Abbreviation Meaning
#> 1 Descriptor MI Shallow (French: Mince)
#> 2 Descriptor BC Patches (French: Bancs)
#> 3 Descriptor BL Blowing
#> 4 Descriptor TS Thunderstorm
#> 5 Descriptor PR Partial
#> 6 Descriptor DR Low drifting
#> 7 Descriptor SH Showers
#> 8 Descriptor FZ Freezing
#> 9 Intensity - Light intensity
#> 10 Intensity + Heavy intensity
#> 11 Intensity blank Moderate intensity
#> 12 Intensity VC In the vicinity
#> 13 Obscuration FG Fog
#> 14 Obscuration BR Mist (French: Brume)
#> 15 Obscuration DU Widespread Dust
#> 16 Obscuration SA Sand
#> 17 Obscuration VA Volcanic Ash
#> 18 Obscuration HZ Haze
#> 19 Obscuration FU Smoke (French: Fumee)
#> 20 Obscuration PY Spray
#> 21 Other SQ Squall
#> 22 Other DS Duststorm
#> 23 Other FC Funnel Cloud
#> 24 Other PO Dust or Sand Whirls
#> 25 Other SS Sandstorm
#> 26 Precipitation RA Rain
#> 27 Precipitation SN Snow
#> 28 Precipitation IC Ice Crystals
#> 29 Precipitation GR Hail (French: Grele)
#> 30 Precipitation UP Unknown Precipitation
#> 31 Precipitation DZ Drizzle
#> 32 Precipitation SG Snow Grains
#> 33 Precipitation PL Ice Pellets
#> 34 Precipitation GS Small Hail and/or Snow Pellets (French: Gresil)
#> 35 Precipitation
#> 36 Time B Began At Time
#> 37 Time 2 digits Minutes of current hour
#> 38 Time E Ended At Time
#> 39 Time 4 digits Hour/Minutes Zulu TimeIn our METAR examples part -RA informs about weather conditions.
metar_wx_codes(my_report)
#> [1] ""This part of a METAR can be quite complex, like in the below example:
metar_wx_codes("202002022205 METAR KEWR 022205Z AUTO 24008KT 6SM -RA -SN BR SCT006 BKN014 OVC024 02/01 A2954 RMK T00200010 MADISHF")
#> [1] "Light intensity: Rain; Light intensity: Snow; Mist (French: Brume)"Next part, SCT028 SCT035 BKN079, informs about a cloud coverage
metar_cloud_coverage(my_report)
#> [1] "Scattered (3-4 oktas) at 11000 ft (3352.8 m)"The temperature and the dew point can be extracted from two elements
of a METAR report, before the RMK remarks marker 23/20 which
can be found in the most reports. Or from the part after the RMK remarks
marker T02300200, more precise but not always available.
The temperature is coded in Celsius degrees, here
23/20, or more detailed in
T02300200.
metar_temp(my_report)
#> [1] 24If there is a letter M in the front of two digits,
M23/00, or there is a digit one after T,
T1230, the temperature is below zero Celsius
degrees.
The dew point can be decoded from the last two digits
23/20, or more detailed from
T02300200. Dew points below zero Celsius degrees are
decoded in the same method as above. For example 04/M03
or T00391033 mean that the dew point temperature is -3
Celsius degrees or more precisely -3.3 Celsius degrees.
metar_dew_point(my_report)
#> [1] 17Here there is a report with the more precise temperature information in the RMK remarks part.
metar_temp("202001010851 METAR KEWR 010851Z 27010KT 10SM FEW030 BKN070 BKN100 BKN210 04/M03 A2969 RMK SLP054 T00391033 52012")
#> [1] 3.9
metar_dew_point("202001010851 METAR KEWR 010851Z 27010KT 10SM FEW030 BKN070 BKN100 BKN210 04/M03 A2969 RMK SLP054 T00391033 52012")
#> [1] -3.3In our example a pressure value is coded in the A2972 as inHg (inch of mercury). With the default parameter altimeter = FALSE, the function metar_pressure returns a pressure in hPa.
metar_pressure(my_report)
#> [1] 1012.53The pressure value can be also presented in a METAR report as Q1008, already in hPa.
metar_pressure("EPWA 281830Z 18009KT 140V200 9999 SCT037 03/M01 Q1008 NOSIG")
#> [1] 1008If a pressure is needed in inHg (inch of mercury), the parameter altimeter has to be set to TRUE.
metar_pressure("EPWA 281830Z 18009KT 140V200 9999 SCT037 03/M01 Q1008 NOSIG", altimeter = TRUE)
#> [1] 29.77Information about wind shear can be extracted with the use of the function metar_windshear().
metar_windshear("CYWG 172000Z 30015G25KT 3/4SM R36/4000FT/D -SN BLSN BKN008 OVC040 M05/M08 A2992 REFZRA WS RWY36 RMK SF5NS3 SLP134")
#> [1] "Wind shear runway RWY36"Information about runways visibility can be extracted with the use of
the function metar_rwy_visibility(), in meters.
In the package version 0.4.0 the parameter sep with the default
value “;” was introduce. It allows to avoid problems with saving output
in .csv files. Two values are allowed, comma and semicolon. If you need
to get the function output separated by commas just set sep =
“,”.
metar_rwy_visibility("CYWG 172000Z 30015G25KT 3/4SM R36/4000FT/D -SN BLSN BKN008 OVC040 M05/M08 A2992 REFZRA WS RWY36 RMK SF5NS3 SLP134")
#> [1] "Runway visual range for runway R36 is 1219.2 meters with downward trend"or in feet
metar_rwy_visibility("CYWG 172000Z 30015G25KT 3/4SM R36/4000FT/D -SN BLSN BKN008 OVC040 M05/M08 A2992 REFZRA WS RWY36 RMK SF5NS3 SLP134",
metric = FALSE)
#> [1] "Runway visual range for runway R36 is 4000 ft with downward trend"Let’s come back to our dm list with historical METAR reports downloaded at the top of this document. Please notice that in all rows there are dates and hours in the front of METAR reports. It will be parsed and placed in the column METAR_Date below.
head(dm)
#> [1] "202006270000 METAR KJFK 270000Z AUTO 19007KT 10SM CLR 23/18 A2990 RMK T02300180 MADISHF"
#> [2] "202006270005 METAR KJFK 270005Z AUTO 19008KT 10SM CLR 24/18 A2990 RMK T02400180 MADISHF"
#> [3] "202006270010 METAR KJFK 270010Z AUTO 20008KT 10SM CLR 24/18 A2990 RMK T02400180 MADISHF"
#> [4] "202006270015 METAR KJFK 270015Z AUTO 21005KT 10SM FEW110 24/18 A2990 RMK T02400180 MADISHF"
#> [5] "202006270020 METAR KJFK 270020Z AUTO 21005KT 10SM SCT110 24/18 A2990 RMK T02400180 MADISHF"
#> [6] "202006270025 METAR KJFK 270025Z AUTO 23008KT 10SM SCT110 24/17 A2990 RMK T02400170 MADISHF"Now we can decode all elements and place them in the tibble. It is
possible to choose between Metric (the default metric = TRUE) or
Imperial (metric = FALSE) systems. Pressure values can be decoded in hPa
(the default altimeter = FALSE) or in mmHg (altimeter = TRUE).
In the package version 0.4.0 the parameter sep with the default
value “;” was introduce. It allows to avoid problems with saving output
in .csv files. Two values are allowed, comma and semicolon. If you need
to get the function output separated by commas just set sep =
“,”. Also the parameter check with the default values TRUE was
added. It allows to handle errors when the function is not able to
decode METAR reports.
decoded_metars <- metar_decode(dm)
#> Getting airport informaiton from the file downloaded from
#> https://ourairports.com/data/
#> created by David MegginsonThe following columns were created:
names(decoded_metars)
#> [1] "Remark" "Airport_ICAO" "METAR_Date"
#> [4] "Day_of_Month" "Hour" "Time_zone"
#> [7] "Wind_speed" "Wind_speed_unit" "Gust"
#> [10] "Gust_unit" "Wind_shear" "Wind_direction"
#> [13] "Temperature" "Dew_point" "Pressure"
#> [16] "Pressure_unit" "Visibility" "Visibility_unit"
#> [19] "Cloud_coverage" "Weather_information" "Runway_visibility"
#> [22] "Airport_Name" "Airport_IATA" "Longitude"
#> [25] "Latitude" "Elevation" "Decode_Date"
#> [28] "Original_METAR"First rows of the tibble with decoded METAR reports:
print.data.frame(head(decoded_metars))
#> Remark Airport_ICAO METAR_Date
#> 1 Don't use for flight planning or navigation! KJFK 2020-06-27 00:00:00
#> 2 Don't use for flight planning or navigation! KJFK 2020-06-27 00:05:00
#> 3 Don't use for flight planning or navigation! KJFK 2020-06-27 00:10:00
#> 4 Don't use for flight planning or navigation! KJFK 2020-06-27 00:15:00
#> 5 Don't use for flight planning or navigation! KJFK 2020-06-27 00:20:00
#> 6 Don't use for flight planning or navigation! KJFK 2020-06-27 00:25:00
#> Day_of_Month Hour Time_zone Wind_speed Wind_speed_unit Gust Gust_unit
#> 1 27 00:00 Z 3.601113 m/s NA m/s
#> 2 27 00:05 Z 4.115558 m/s NA m/s
#> 3 27 00:10 Z 4.115558 m/s NA m/s
#> 4 27 00:15 Z 2.572223 m/s NA m/s
#> 5 27 00:20 Z 2.572223 m/s NA m/s
#> 6 27 00:25 Z 4.115558 m/s NA m/s
#> Wind_shear Wind_direction Temperature Dew_point Pressure Pressure_unit
#> 1 <NA> 190 23 18 1012.53 hPa
#> 2 <NA> 190 24 18 1012.53 hPa
#> 3 <NA> 200 24 18 1012.53 hPa
#> 4 <NA> 210 24 18 1012.53 hPa
#> 5 <NA> 210 24 18 1012.53 hPa
#> 6 <NA> 230 24 17 1012.53 hPa
#> Visibility Visibility_unit
#> 1 16093.44 m
#> 2 16093.44 m
#> 3 16093.44 m
#> 4 16093.44 m
#> 5 16093.44 m
#> 6 16093.44 m
#> Cloud_coverage
#> 1 No clouds below 12 000 ft (3 700 m) (U.S.) or 25 000 ft (7 600 m) (Canada)
#> 2 No clouds below 12 000 ft (3 700 m) (U.S.) or 25 000 ft (7 600 m) (Canada)
#> 3 No clouds below 12 000 ft (3 700 m) (U.S.) or 25 000 ft (7 600 m) (Canada)
#> 4 Few (1-2 oktas) at 11000 ft (3352.8 m)
#> 5 Scattered (3-4 oktas) at 11000 ft (3352.8 m)
#> 6 Scattered (3-4 oktas) at 11000 ft (3352.8 m)
#> Weather_information Runway_visibility Airport_Name
#> 1 John F Kennedy International Airport
#> 2 John F Kennedy International Airport
#> 3 John F Kennedy International Airport
#> 4 John F Kennedy International Airport
#> 5 John F Kennedy International Airport
#> 6 John F Kennedy International Airport
#> Airport_IATA Longitude Latitude Elevation Decode_Date
#> 1 JFK -73.7789 40.6398 3.9624 2022-08-29 22:03:24
#> 2 JFK -73.7789 40.6398 3.9624 2022-08-29 22:03:24
#> 3 JFK -73.7789 40.6398 3.9624 2022-08-29 22:03:24
#> 4 JFK -73.7789 40.6398 3.9624 2022-08-29 22:03:24
#> 5 JFK -73.7789 40.6398 3.9624 2022-08-29 22:03:24
#> 6 JFK -73.7789 40.6398 3.9624 2022-08-29 22:03:24
#> Original_METAR
#> 1 202006270000 METAR KJFK 270000Z AUTO 19007KT 10SM CLR 23/18 A2990 RMK T02300180 MADISHF
#> 2 202006270005 METAR KJFK 270005Z AUTO 19008KT 10SM CLR 24/18 A2990 RMK T02400180 MADISHF
#> 3 202006270010 METAR KJFK 270010Z AUTO 20008KT 10SM CLR 24/18 A2990 RMK T02400180 MADISHF
#> 4 202006270015 METAR KJFK 270015Z AUTO 21005KT 10SM FEW110 24/18 A2990 RMK T02400180 MADISHF
#> 5 202006270020 METAR KJFK 270020Z AUTO 21005KT 10SM SCT110 24/18 A2990 RMK T02400180 MADISHF
#> 6 202006270025 METAR KJFK 270025Z AUTO 23008KT 10SM SCT110 24/17 A2990 RMK T02400170 MADISHFLet’s take a look how the function handles the input data with one erroneous report.
metar_decode(dc)
#> Getting airport informaiton from the file downloaded from
#> https://ourairports.com/data/
#> created by David Megginson
#> # A tibble: 6 × 28
#> Remark Airpo…¹ METAR…² Day_o…³ Hour Time_…⁴ Wind_…⁵ Wind_…⁶ Gust Gust_…⁷
#> <chr> <chr> <chr> <dbl> <chr> <chr> <dbl> <chr> <dbl> <chr>
#> 1 Don't use… KJFK 2020-0… 27 00:00 Z 3.60 m/s NA m/s
#> 2 Don't use… KJFK 2020-0… 27 00:05 Z 4.12 m/s NA m/s
#> 3 Don't use… KJFK 2020-0… 27 00:10 Z 4.12 m/s NA m/s
#> 4 Don't use… KJFK 2020-0… 27 00:15 Z 2.57 m/s NA m/s
#> 5 Don't use… KJFK 2020-0… 27 00:20 Z 2.57 m/s NA m/s
#> 6 Incorrect… <NA> <NA> NA <NA> <NA> NA m/s NA m/s
#> # … with 18 more variables: Wind_shear <chr>, Wind_direction <chr>,
#> # Temperature <dbl>, Dew_point <dbl>, Pressure <dbl>, Pressure_unit <chr>,
#> # Visibility <chr>, Visibility_unit <chr>, Cloud_coverage <chr>,
#> # Weather_information <chr>, Runway_visibility <chr>, Airport_Name <chr>,
#> # Airport_IATA <chr>, Longitude <dbl>, Latitude <dbl>, Elevation <dbl>,
#> # Decode_Date <chr>, Original_METAR <chr>, and abbreviated variable names
#> # ¹Airport_ICAO, ²METAR_Date, ³Day_of_Month, ⁴Time_zone, ⁵Wind_speed, …
#> # ℹ Use `colnames()` to see all variable namesThe parameter check can set to FALSE and some values from incorrect reports can decoded. However the function can fail.
The function metar_print() it is possible to decode one report and display main parameters
metar_print(dm[1])
#> Getting airport informaiton from the file downloaded from
#> https://ourairports.com/data/
#> created by David Megginson
#> Decoded METAR report
#> --------------------
#> Remarks : Don't use for flight planning or navigation!
#> Airport ICAO code : KJFK
#> METAR date : 2020-06-27
#> Day of month : 27
#> Hour : 00:00
#> Time zone : Z
#> Wind speed : 3.6 m/s
#> Gust : NA
#> Wind shear : NA
#> Wind direction : 190
#> Temperature : 23 °C
#> Dew point : 18 °C
#> Pressure : 1012.53 hPa
#> Visibility : 16093.44 m
#> Cloud coverage : No clouds below 12 000 ft (3 700 m) (U.S.) or 25 000 ft (7 600 m) (Canada)
#> Weather information:
#> Runway visibility :
#> Airport name : John F Kennedy International Airport
#> Airport IATA code : JFK
#> Longitude : -73.7789 °
#> Latitude : 40.6398 °
#> Elevation : 4.0 m
#> Decode date : 2022-08-29 22:03:24
#> Original METAR : 202006270000 METAR KJFK 270000Z AUTO 19007KT 10SM CLR 23/18 A2990 RMK T02300180 MADISHF