From 5f8d8e912f87c5e491b33059bc9fcd2dc81c9e87 Mon Sep 17 00:00:00 2001 From: Elin Waring Date: Wed, 27 Apr 2022 02:20:31 -0400 Subject: [PATCH] Update readme. --- README.Rmd | 28 ++++++++++++++++++++++++++-- README.md | 26 +++++++++++++++++++++++--- 2 files changed, 49 insertions(+), 5 deletions(-) diff --git a/README.Rmd b/README.Rmd index 3403a53..83898c6 100644 --- a/README.Rmd +++ b/README.Rmd @@ -6,7 +6,6 @@ output: github_document [![GitHub (pre-)release](https://img.shields.io/github/release/ropensci/rrricanes/all.svg)](https://github.com/ropensci/rrricanes/tags) [![](https://badges.ropensci.org/118_status.svg)](https://github.com/ropensci/onboarding/issues/118) [![CRAN_Status_Badge](http://www.r-pkg.org/badges/version/rrricanes)](https://cran.r-project.org/package=rrricanes) - [![R-CMD-check](https://github.com/ropensci/rrricanes/workflows/R-CMD-check/badge.svg)](https://github.com/ropensci/rrricanes/actions) [![codecov](https://codecov.io/gh/ropensci/rrricanes/branch/master/graph/badge.svg)](https://codecov.io/gh/ropensci/rrricanes) @@ -28,6 +27,26 @@ Central Pacific data (140°W to 180°W) is included if issued by the [Nati This library parses the text advisories of all tropical cyclones since 1998. Over the years the formats of the text products have changed and many are loosely formatted. +## Current Status of rrricanes + +rrcanes is not currently on CRAN. A group of people +(who welcome others to join us) are working +on updating the package and get it back into shape +for submission to CRAN. Because it has been +a while we are taking the opportunity to do +some updating and refactoring. Specifically +we are working to get the package working with +the recent [https://r-spatial.org/](changes in +the R spatial ecosystem). When possible we +are also shifting to more modern APIs for +accessing the data when they are available. + +Please report any issues and share ideas in the +issue tracker and code with pull requests. + + +## Package background + I wrote this package with the goal of consolidating messy text data into well-organized formats that can easily be saved to CSV, SQL and other data formats. ## Advisory Products @@ -68,6 +87,7 @@ vignette("getting_started", package = "rrricanes") Linux users must also have the `libgdal-dev`, `libproj-dev` and `libxml2-dev` packages installed. + To add `rrricanesdata`, a [package of post-scraped datasets](https://github.com/ropensci/rrricanesdata), ```r @@ -75,6 +95,7 @@ install.packages("rrricanesdata", repos = "https://timtrice.github.io/drat/", type = "source") ``` +However this package is not currently maintained. To use high resolution tracking maps you will need to install the `rnaturalearthhires` package. @@ -94,7 +115,10 @@ devtools::install_github("ropensci/rrricanes", build_vignettes = TRUE) ## Built With -* [R 3.3.3](https://www.r-project.org/) - The R Project for Statistical Computing +* [R 4.1](https://www.r-project.org/) - The R Project for Statistical Computing + +New minimum versions for a number of dependencies have been establised. +This provides opportunity to build on newer features of the packages ## Contributing diff --git a/README.md b/README.md index 0d2c583..8de4f15 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,6 @@ version](https://img.shields.io/badge/R%3E%3D-3.5.0-6666ff.svg)](https://cran.r- (pre-)release](https://img.shields.io/github/release/ropensci/rrricanes/all.svg)](https://github.com/ropensci/rrricanes/tags) [![](https://badges.ropensci.org/118_status.svg)](https://github.com/ropensci/onboarding/issues/118) [![CRAN_Status_Badge](http://www.r-pkg.org/badges/version/rrricanes)](https://cran.r-project.org/package=rrricanes) - [![R-CMD-check](https://github.com/ropensci/rrricanes/workflows/R-CMD-check/badge.svg)](https://github.com/ropensci/rrricanes/actions) [![codecov](https://codecov.io/gh/ropensci/rrricanes/branch/master/graph/badge.svg)](https://codecov.io/gh/ropensci/rrricanes) @@ -32,6 +31,22 @@ This library parses the text advisories of all tropical cyclones since 1998. Over the years the formats of the text products have changed and many are loosely formatted. +## Current Status of rrricanes + +rrcanes is not currently on CRAN. A group of people (who welcome others +to join us) are working on updating the package and get it back into +shape for submission to CRAN. Because it has been a while we are taking +the opportunity to do some updating and refactoring. Specifically we are +working to get the package working with the recent +[https://r-spatial.org/](changes%20in%20the%20R%20spatial%20ecosystem). +When possible we are also shifting to more modern APIs for accessing the +data when they are available. + +Please report any issues and share ideas in the issue tracker and code +with pull requests. + +## Package background + I wrote this package with the goal of consolidating messy text data into well-organized formats that can easily be saved to CSV, SQL and other data formats. @@ -110,6 +125,8 @@ install.packages("rrricanesdata", type = "source") ``` +However this package is not currently maintained. + To use high resolution tracking maps you will need to install the `rnaturalearthhires` package. @@ -130,8 +147,11 @@ devtools::install_github("ropensci/rrricanes", build_vignettes = TRUE) ## Built With -- [R 3.3.3](https://www.r-project.org/) - The R Project for - Statistical Computing +- [R 4.1](https://www.r-project.org/) - The R Project for Statistical + Computing + +New minimum versions for a number of dependencies have been establised. +This provides opportunity to build on newer features of the packages ## Contributing