Merge pull request #37 from panukatan/dev

prepare for CRAN release

DESCRIPTION

@@ -6,17 +6,17 @@ Authors@R: person(given = "Ernest",
                   family = "Guevarra", 
                   comment = c(ORCID = "0000-0002-4887-4415"), 
                   email = "ernest@guevarra.io", 
-                  role = c("aut", "cre"))
+                  role = c("aut", "cre", "cph"))
 Description: The Philippines frequently experiences tropical cyclones (called
     'bagyo' in the Filipino language) because of its geographical position. 
     These cyclones typically bring heavy rainfall, leading to widespread 
     flooding, as well as strong winds that cause significant damage to human 
     life, crops, and property. Data on cyclones are collected and curated by the 
     Philippine Atmospheric, Geophysical, and Astronomical Services 
-    Administration (PAGASA) and made available through its website. This package 
-    contains Philippine tropical cyclones data in a machine-readable format. It 
-    is hoped that this data package provides an interesting and unique dataset 
-    for data exploration and visualisation.
+    Administration or 'PAGASA' and made available through its website. This 
+    package contains Philippine tropical cyclones data in a machine-readable 
+    format. It is hoped that this data package provides an interesting and 
+    unique dataset for data exploration and visualisation.
 License: CC0
 Depends: 
     R (>= 2.10)

R/get_cyclone.R

@@ -34,6 +34,9 @@ get_bagyo <- function() {
 #'
 #' @returns Printed output of [get_bagyo()] function
 #'
+#' @examples
+#' get_bagyo()
+#'
 #' @export
 #'
 

README.Rmd

@@ -23,9 +23,10 @@ library(tibble)
 # bagyo: Philippine Tropical Cyclones Data <img src="man/figures/logo.png" width="200" align="right" />
 
 <!-- badges: start -->
-[![Project Status: WIP – Initial development is in progress, but there has not yet been a stable, usable release suitable for the public.](https://www.repostatus.org/badges/latest/wip.svg)](https://www.repostatus.org/#wip)
-[![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental)
+[![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
+[![Lifecycle: stable](https://img.shields.io/badge/lifecycle-stable-brightgreen.svg)](https://lifecycle.r-lib.org/articles/stages.html#stable)
 [![R-CMD-check](https://github.com/panukatan/bagyo/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/panukatan/bagyo/actions/workflows/R-CMD-check.yaml)
+[![R-hub](https://github.com/panukatan/bagyo/actions/workflows/rhub.yaml/badge.svg)](https://github.com/panukatan/bagyo/actions/workflows/rhub.yaml)
 [![test-coverage](https://github.com/panukatan/bagyo/actions/workflows/test-coverage.yaml/badge.svg)](https://github.com/panukatan/bagyo/actions/workflows/test-coverage.yaml)
 [![Codecov test coverage](https://codecov.io/gh/panukatan/bagyo/branch/main/graph/badge.svg)](https://app.codecov.io/gh/panukatan/bagyo?branch=main)
 [![CodeFactor](https://www.codefactor.io/repository/github/panukatan/bagyo/badge)](https://www.codefactor.io/repository/github/panukatan/bagyo)
@@ -40,7 +41,13 @@ This package contains Philippine tropical cyclones data from 2017 to 2020 in a m
 
 ## Installation
 
-`bagyo` is not yet on CRAN but can be installed from the [panukatan R universe](https://panukatan.r-universe.dev) as follows:
+You can install `bagyo` from [CRAN](https://cran.r-project.org) with:
+
+```{r install-cran, echo = TRUE, eval = FALSE}
+install.packages("bagyo")
+```
+
+You can install the development version of `bagyo` from the [panukatan r-universe](https://panukatan.r-universe.dev) with:
 
 ```{r install-r-universe, eval = FALSE}
 install.packages(

README.md

@@ -5,12 +5,13 @@
 
 <!-- badges: start -->
 
-[![Project Status: WIP – Initial development is in progress, but there
-has not yet been a stable, usable release suitable for the
-public.](https://www.repostatus.org/badges/latest/wip.svg)](https://www.repostatus.org/#wip)
+[![Project Status: Active – The project has reached a stable, usable
+state and is being actively
+developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
 [![Lifecycle:
-experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental)
+stable](https://img.shields.io/badge/lifecycle-stable-brightgreen.svg)](https://lifecycle.r-lib.org/articles/stages.html#stable)
 [![R-CMD-check](https://github.com/panukatan/bagyo/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/panukatan/bagyo/actions/workflows/R-CMD-check.yaml)
+[![R-hub](https://github.com/panukatan/bagyo/actions/workflows/rhub.yaml/badge.svg)](https://github.com/panukatan/bagyo/actions/workflows/rhub.yaml)
 [![test-coverage](https://github.com/panukatan/bagyo/actions/workflows/test-coverage.yaml/badge.svg)](https://github.com/panukatan/bagyo/actions/workflows/test-coverage.yaml)
 [![Codecov test
 coverage](https://codecov.io/gh/panukatan/bagyo/branch/main/graph/badge.svg)](https://app.codecov.io/gh/panukatan/bagyo?branch=main)
@@ -49,8 +50,14 @@ dataset.
 
 ## Installation
 
-`bagyo` is not yet on CRAN but can be installed from the [panukatan R
-universe](https://panukatan.r-universe.dev) as follows:
+You can install `bagyo` from [CRAN](https://cran.r-project.org) with:
+
+``` r
+install.packages("bagyo")
+```
+
+You can install the development version of `bagyo` from the [panukatan
+r-universe](https://panukatan.r-universe.dev) with:
 
 ``` r
 install.packages(

cran-comments.md

@@ -3,9 +3,3 @@
 0 errors | 0 warnings | 1 note
 
 * This is a new release.
-
-* Possibly misspelled words in DESCRIPTION:
-      PAGASA (15:73)
-      bagyo (11:5)
-
-  These words are not misspelled.