Skip to content

Commit

Permalink
Updated links and added notice of rnoaas lack of support
Browse files Browse the repository at this point in the history
  • Loading branch information
andybeet committed Dec 28, 2024
1 parent 320c0f4 commit 1705c1a
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 5 deletions.
9 changes: 8 additions & 1 deletion README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,13 @@ knitr::opts_chunk$set(
[![Hits](https://hits.seeyoufarm.com/api/count/incr/badge.svg?url=https%3A%2F%2Fgithub.com%2FNOAA-EDAB%2Fbuoydata&count_bg=%2379C83D&title_bg=%23555555&icon=&icon_color=%23E7E7E7&title=hits&edge_flat=false)](https://hits.seeyoufarm.com)
<!-- badges: end -->

The goal of `buoydata` is to easily download and process buoy data hosted by National Data Buoy Center. Note: the [rnoaa](https://github.com/ropensci/rnoaa) package also has functions to get buoy data. The difference is that (in [rnoaa](https://github.com/ropensci/rnoaa)) only one years worth of data can be downloaded at any time from a single buoy.
The goal of `buoydata` is to easily download and process buoy data hosted by [National Data Buoy Center](https://www.ndbc.noaa.gov/). Note: the [rnoaa](https://github.com/ropensci/rnoaa) package also has functions to get buoy data. The difference is that (in [rnoaa](https://github.com/ropensci/rnoaa)) only one years worth of data can be downloaded at any time from a single buoy. Note: **As of 2023 [rnoaa](https://github.com/ropensci/rnoaa) is no longer officially supported**

`buoydata` downloads multiple years and stitches all years data together in a single data frame. In addition the lazily loaded station description data provided with the package combines many more attributes (than [rnoaa](https://github.com/ropensci/rnoaa)) by which to filter.




*Date of most recent data pull: `r strsplit(as.character(file.info(here::here("data-raw","datapull.txt"))$mtime)," ")[[1]][1]`*

## Installation
Expand Down Expand Up @@ -64,6 +67,10 @@ Then plot the data

<img src="man/figures/WTMP44013.png" align="center" width="100%"/>

## Reference

[Documentation](https://www.ndbc.noaa.gov/faq/measdes.shtml) of the meteorological data can be found on the National Data Buoy Center website


## Contact

Expand Down
16 changes: 12 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,13 @@
<!-- badges: end -->

The goal of `buoydata` is to easily download and process buoy data
hosted by National Data Buoy Center. Note: the
[rnoaa](https://github.com/ropensci/rnoaa) package also has functions to
get buoy data. The difference is that (in
hosted by [National Data Buoy Center](https://www.ndbc.noaa.gov/). Note:
the [rnoaa](https://github.com/ropensci/rnoaa) package also has
functions to get buoy data. The difference is that (in
[rnoaa](https://github.com/ropensci/rnoaa)) only one years worth of data
can be downloaded at any time from a single buoy.
can be downloaded at any time from a single buoy. Note: **As of 2023
[rnoaa](https://github.com/ropensci/rnoaa) is no longer officially
supported**

`buoydata` downloads multiple years and stitches all years data together
in a single data frame. In addition the lazily loaded station
Expand Down Expand Up @@ -74,6 +76,12 @@ Then plot the data

<img src="man/figures/WTMP44013.png" align="center" width="100%"/>

## Reference

[Documentation](https://www.ndbc.noaa.gov/faq/measdes.shtml) of the
meteorological data can be found on the National Data Buoy Center
website

## Contact

| [andybeet](https://github.com/andybeet) |
Expand Down

0 comments on commit 1705c1a

Please sign in to comment.