bomrang
Australian government Bureau of Meteorology (BOM) data client for R.
https://github.com/ropensci-archive/bomrang
Keywords
australia australia-bureau-of-meteorology bom meteorological-data meteorology peer-reviewed r r-package rstats weather weather-data weather-forecast
Last synced: over 1 year ago
JSON representation
Acceptance Criteria
- Revelant topics? true
- External users? true
- Open source license? true
- Active? false
- Fork? false
Repository metadata
:warning: ARCHIVED :warning: Australian government Bureau of Meteorology (BOM) data client for R
- Host: GitHub
- URL: https://github.com/ropensci-archive/bomrang
- Owner: ropensci-archive
- License: other
- Archived: true
- Created: 2017-04-28T09:23:20.000Z (about 8 years ago)
- Default Branch: main
- Last Pushed: 2023-01-10T01:27:42.000Z (over 2 years ago)
- Last Synced: 2024-01-24T02:36:33.467Z (over 1 year ago)
- Topics: australia, australia-bureau-of-meteorology, bom, meteorological-data, meteorology, peer-reviewed, r, r-package, rstats, weather, weather-data, weather-forecast
- Language: R
- Homepage:
- Size: 49.5 MB
- Stars: 108
- Watchers: 21
- Forks: 26
- Open Issues: 1
- Releases: 0
-
Metadata Files:
- Readme: README-old.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
README-old.md
bomrang: Australian Government Bureau of Meteorology (BOM) Data Client
Provides functions to interface with Australian Government Bureau of Meteorology (BOM) data, fetching data and returning a tidy data frame of précis forecasts, current weather data from stations, ag information bulletins, historical weather data and downloading and importing radar or satellite imagery.
Credit for the name, bomrang, goes to Di Cook, who suggested it while attending the rOpenSci AUUnconf in Brisbane, 2016.
NOTE
BOM have decided that the data that they provide should not all be easily available.
Therefore, some portions of this package (any that depend on HTTP requests) are now broken.
These include:
get_historical_weather()
,get_weather_bulletins()
, andget_current_weather()
All other functions in the package work as advertise assuming server availability as they rely on FTP requests.
BOM's official statement
Website notification of change
Scheduled Release Date: 3 March 2021
A web application firewall policy has been implemented for www.bom.gov.au which will block screen scraping activity.
The Bureau is monitoring screen scraping activity on the site and will commence interrupting, and eventually blocking, this activity on www.bom.gov.au from Wednesday, 3 March 2021. This is aimed at protecting infrastructure, system access and security, intellectual property and server/service load.
Web or screen scraping is the act of copying information that shows on a digital display so it can be used for another purpose. This activity has always been at odds with the Bureau's terms and conditions.
We understand www.bom.gov.au contributes significantly to the work of many individuals and organisations and we are committed to continuing to provide access through our registered user’s channel.
For further information, or to discuss the ongoing use of our materials, please make contact with us via [email protected].
Quick Start
bomrang has been archived from CRAN for reasons beyond bomrang actually being broken.
As such at this time I've declined to "fix" the package.
It can still be installed using the following commands.
if (!require("remotes")) {
install.packages("remotes", repos = "http://cran.rstudio.com/")
library("remotes")
}
install_github("ropensci/bomrang", build_vignettes = TRUE)
Using bomrang
Several functions are provided by bomrang to retrieve Australian Bureau of Meteorology (BOM) data. A family of functions retrieve weather data and return tidy data frames;
-
get_precis_forecast()
, which retrieves the précis (short) forecast; -
get_current_weather()
, which fetches the current weather for a given station; -
get_ag_bulletin()
, which retrieves the agriculture bulletin; -
get_weather_bulletin()
, which retrieves the BOM 0900 or 1500 bulletins; -
get_coastal_forecast()
, which returns coastal waters forecasts; -
get_historical_weather()
, which retrieves historical daily observations for a given station; and
A second group of functions retrieve information pertaining to satellite and radar imagery,
-
get_available_imagery()
; -
the satellite imagery itself,
get_satellite_imagery()
; -
get_available_radar()
; and -
the radar imagery itself,
get_radar_imagery()
.
Vignettes are provided illustrating examples
of all functions and a use case.
Meta
-
Please report any issues or bugs.
-
License:
-
All code is licensed MIT
-
All data is copyright Australia Bureau of Meteorology, BOM Copyright Notice http://reg.bom.gov.au/other/copyright.shtml
-
-
To cite bomrang, please use the output from
citation("bomrang")
-
Please note that the bomrang project is released with a
Contributor Code of Conduct.
By participating in the bomrang project you agree to abide by its terms.
References
Australian Bureau of Meteorology (BOM) Weather Data Services
Australian Bureau of Meteorology (BOM) FTP Public Products
Australian Bureau of Meteorology (BOM) Weather Data Services Agriculture Bulletins
Australian Bureau of Meteorology (BOM) Weather Data Services Observation of Rainfall
Australian Bureau of Meteorology (BOM) High-definition satellite images
Owner metadata
- Name: rOpenSci Archive
- Login: ropensci-archive
- Email: [email protected]
- Kind: organization
- Description: Abandoned rOpenSci projects -- email [email protected] if you have questions!
- Website: ropensci.org
- Location:
- Twitter:
- Company:
- Icon url: https://avatars.githubusercontent.com/u/68704009?v=4
- Repositories: 183
- Last ynced at: 2023-03-12T06:32:33.421Z
- Profile URL: https://github.com/ropensci-archive
GitHub Events
Total
- Watch event: 5
- Fork event: 2
Last Year
- Fork event: 1
- Watch event: 5
Committers metadata
Last synced: over 1 year ago
Total Commits: 1,699
Total Committers: 11
Avg Commits per committer: 154.455
Development Distribution Score (DDS): 0.089
Commits in past year: 2
Committers in past year: 1
Avg Commits per committer in past year: 2.0
Development Distribution Score (DDS) in past year: 0.0
Name | Commits | |
---|---|---|
Adam H. Sparks | a****s@g****m | 1547 |
HughParsonage | h****e@g****m | 67 |
melloy | p****l@m****u | 28 |
Jonathan Carroll | j****o@j****u | 22 |
deanmarchiori | d****i@g****m | 16 |
Dean Marchiori | d****i@i****u | 6 |
mpadge | m****m@e****m | 5 |
James Goldie | me@r****o | 3 |
Grace Li | g****8@b****u | 2 |
Keith-Pembleton | k****n@u****u | 2 |
Arfon Smith | a****n | 1 |
Committer domains:
- usq.edu.au: 1
- berkeley.edu: 1
- rensa.co: 1
- email.com: 1
- internetrix.com.au: 1
- jcarroll.com.au: 1
- melloy.com.au: 1
Issue and Pull Request metadata
Last synced: over 1 year ago
Total issues: 103
Total pull requests: 39
Average time to close issues: 4 months
Average time to close pull requests: 10 days
Total issue authors: 23
Total pull request authors: 9
Average comments per issue: 4.32
Average comments per pull request: 2.23
Merged pull request: 34
Bot issues: 0
Bot pull requests: 0
Past year issues: 0
Past year pull requests: 0
Past year average time to close issues: N/A
Past year average time to close pull requests: N/A
Past year issue authors: 0
Past year pull request authors: 0
Past year average comments per issue: 0
Past year average comments per pull request: 0
Past year merged pull request: 0
Past year bot issues: 0
Past year bot pull requests: 0
Top Issue Authors
- adamhsparks (68)
- jimjam-slam (4)
- deanmarchiori (4)
- KyleHaynes (3)
- HughParsonage (3)
- brendo1001 (2)
- ozjimbob (2)
- lzb5600 (2)
- TristanLouthRobins (1)
- rward3182 (1)
- paulr-bv (1)
- offwinter (1)
- njtierney (1)
- mpadge (1)
- mbertolacci (1)
Top Pull Request Authors
- HughParsonage (17)
- jonocarroll (6)
- deanmarchiori (4)
- mpadge (4)
- adamhsparks (3)
- jimjam-slam (2)
- graceli8 (1)
- PaulMelloy (1)
- arfon (1)
Top Issue Labels
- bug (15)
- enhancement (14)
- question (4)
- wontfix (1)
Top Pull Request Labels
- bug (2)
Dependencies
- R >= 3.5.0 depends
- crayon * imports
- curl >= 2.8.1 imports
- data.table >= 1.10.4 imports
- dplyr >= 0.7.0 imports
- foreign * imports
- hoardr * imports
- httr >= 1.2.1 imports
- janitor >= 1.0.0 imports
- jsonlite >= 1.5 imports
- lubridate * imports
- magick * imports
- magrittr >= 1.5 imports
- readr >= 1.1.1 imports
- rvest * imports
- terra * imports
- tidyr >= 0.6.3 imports
- tools * imports
- utils * imports
- xml2 >= 1.1.1 imports
- ASGS.foyer * suggests
- covr * suggests
- ggplot2 * suggests
- ggthemes * suggests
- grid * suggests
- gridExtra * suggests
- knitr * suggests
- mapproj * suggests
- maps * suggests
- rappdirs * suggests
- rmarkdown * suggests
- roxygen2 >= 6.1.0 suggests
- testthat * suggests
Score: 7.089243155027514