setup submission release version

.Rbuildignore

@@ -8,3 +8,4 @@
 ^_pkgdown\.yml$
 ^docs$
 ^pkgdown$
+^cran-comments\.md$

.github/workflows/rhub.yaml

@@ -0,0 +1,95 @@
+# R-hub's generic GitHub Actions workflow file. It's canonical location is at
+# https://github.com/r-hub/actions/blob/v1/workflows/rhub.yaml
+# You can update this file to a newer version using the rhub2 package:
+#
+# rhub::rhub_setup()
+#
+# It is unlikely that you need to modify this file manually.
+
+name: R-hub
+run-name: "${{ github.event.inputs.id }}: ${{ github.event.inputs.name || format('Manually run by {0}', github.triggering_actor) }}"
+
+on:
+  workflow_dispatch:
+    inputs:
+      config:
+        description: 'A comma separated list of R-hub platforms to use.'
+        type: string
+        default: 'linux,windows,macos'
+      name:
+        description: 'Run name. You can leave this empty now.'
+        type: string
+      id:
+        description: 'Unique ID. You can leave this empty now.'
+        type: string
+
+jobs:
+
+  setup:
+    runs-on: ubuntu-latest
+    outputs:
+      containers: ${{ steps.rhub-setup.outputs.containers }}
+      platforms: ${{ steps.rhub-setup.outputs.platforms }}
+
+    steps:
+    # NO NEED TO CHECKOUT HERE
+    - uses: r-hub/actions/setup@v1
+      with:
+        config: ${{ github.event.inputs.config }}
+      id: rhub-setup
+
+  linux-containers:
+    needs: setup
+    if: ${{ needs.setup.outputs.containers != '[]' }}
+    runs-on: ubuntu-latest
+    name: ${{ matrix.config.label }}
+    strategy:
+      fail-fast: false
+      matrix:
+        config: ${{ fromJson(needs.setup.outputs.containers) }}
+    container:
+      image: ${{ matrix.config.container }}
+
+    steps:
+      - uses: r-hub/actions/checkout@v1
+      - uses: r-hub/actions/platform-info@v1
+        with:
+          token: ${{ secrets.RHUB_TOKEN }}
+          job-config: ${{ matrix.config.job-config }}
+      - uses: r-hub/actions/setup-deps@v1
+        with:
+          token: ${{ secrets.RHUB_TOKEN }}
+          job-config: ${{ matrix.config.job-config }}
+      - uses: r-hub/actions/run-check@v1
+        with:
+          token: ${{ secrets.RHUB_TOKEN }}
+          job-config: ${{ matrix.config.job-config }}
+
+  other-platforms:
+    needs: setup
+    if: ${{ needs.setup.outputs.platforms != '[]' }}
+    runs-on: ${{ matrix.config.os }}
+    name: ${{ matrix.config.label }}
+    strategy:
+      fail-fast: false
+      matrix:
+        config: ${{ fromJson(needs.setup.outputs.platforms) }}
+
+    steps:
+      - uses: r-hub/actions/checkout@v1
+      - uses: r-hub/actions/setup-r@v1
+        with:
+          job-config: ${{ matrix.config.job-config }}
+          token: ${{ secrets.RHUB_TOKEN }}
+      - uses: r-hub/actions/platform-info@v1
+        with:
+          token: ${{ secrets.RHUB_TOKEN }}
+          job-config: ${{ matrix.config.job-config }}
+      - uses: r-hub/actions/setup-deps@v1
+        with:
+          job-config: ${{ matrix.config.job-config }}
+          token: ${{ secrets.RHUB_TOKEN }}
+      - uses: r-hub/actions/run-check@v1
+        with:
+          job-config: ${{ matrix.config.job-config }}
+          token: ${{ secrets.RHUB_TOKEN }}

DESCRIPTION

@@ -1,22 +1,22 @@
 Package: bagyo
 Type: Package
 Title: Philippine Tropical Cyclones Data
-Version: 0.0.0.9000
+Version: 0.1.0
 Authors@R: person(given = "Ernest", 
                   family = "Guevarra", 
                   comment = c(ORCID = "0000-0002-4887-4415"), 
                   email = "ernest@guevarra.io", 
                   role = c("aut", "cre"))
 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 Cyclone data in a machine-readable format. It is hoped that this
-    data package provides an interesting and unique dataset for data exploration 
-    and visualisation.
+    '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.
 License: CC0
 Depends: 
     R (>= 2.10)

NEWS.md

@@ -1,3 +1,8 @@
+# bagyo 0.1.0
+
+This is the first CRAN release of `bagyo`.
+
+
 # bagyo v0.0.0.9000
 
 This is a pre-release of `bagyo`.

R/bagyo-package.R

@@ -1,14 +1,14 @@
 #'
 #' Philippine Tropical Cyclones Data
 #'
-#' The Philippines frequently experiences tropical cyclones (called bagyo in the
-#' Filipino language) because of its geographical position. These cyclones
+#' 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 Cyclone data in a machine-readable format. It is hoped that this
+#' 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 as an adjunct to the traditional `iris` dataset and to the
 #' current `palmerpenguins` dataset.

README.Rmd

@@ -29,6 +29,7 @@ library(tibble)
 [![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)
+[![DOI](https://zenodo.org/badge/314686124.svg)](https://zenodo.org/doi/10.5281/zenodo.10972234)
 <!-- badges: end -->
 
 Oceans and seas significantly impact continental weather, with evaporation from the sea surface driving cloud formation and precipitation. Tropical cyclones, warm-core low-pressure systems, form over warm oceans where temperatures exceed 26°C, precipitated by the release of latent heat from condensation. These cyclones, known by various names depending on the region, have organised circulations and develop primarily in tropical and subtropical waters, except in regions with cooler sea surface temperatures and high vertical wind shears. They reach peak intensity over warm tropical waters and weaken upon landfall, often causing extensive damage before dissipating.

README.md

@@ -15,6 +15,7 @@ experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](h
 [![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)
+[![DOI](https://zenodo.org/badge/314686124.svg)](https://zenodo.org/doi/10.5281/zenodo.10972234)
 <!-- badges: end -->
 
 Oceans and seas significantly impact continental weather, with
@@ -141,17 +142,20 @@ citation provided by a call to the `citation()` function as follows:
 citation("bagyo")
 #> To cite bagyo in publications use:
 #> 
-#>   Ernest Guevarra (2024). _bagyo: Philippine Tropical Cyclones Data_. R
-#>   package version 0.0.0.9000, <https://panukatan.io/bagyo/>.
+#>   Ernest Guevarra (2024). _bagyo: Philippine Tropical Cyclones Data_.
+#>   doi:10.5281/zenodo.10972235
+#>   <https://doi.org/10.5281/zenodo.10972235>, R package version 0.1.0,
+#>   <https://panukatan.io/bagyo/>.
 #> 
 #> A BibTeX entry for LaTeX users is
 #> 
 #>   @Manual{,
 #>     title = {bagyo: Philippine Tropical Cyclones Data},
 #>     author = {{Ernest Guevarra}},
 #>     year = {2024},
-#>     note = {R package version 0.0.0.9000},
+#>     note = {R package version 0.1.0},
 #>     url = {https://panukatan.io/bagyo/},
+#>     doi = {10.5281/zenodo.10972235},
 #>   }
 ```
 

cran-comments.md

@@ -0,0 +1,11 @@
+## R CMD check results
+
+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.

inst/CITATION

@@ -4,6 +4,7 @@ bibentry(
   title    = "bagyo: Philippine Tropical Cyclones Data",
   author   = person("Ernest Guevarra"),
   year     = "2024",
-  note     = "R package version 0.0.0.9000",
-  url      = "https://panukatan.io/bagyo/"
+  note     = "R package version 0.1.0",
+  url      = "https://panukatan.io/bagyo/",
+  doi      = "10.5281/zenodo.10972235"
 )

pkgdown/_pkgdown.yml

@@ -22,23 +22,26 @@ navbar:
   type: light
   structure:
     left:  [home, intro, reference, articles, news]
-    #right: [mastodon, facebook, linkedin, github]
+    right: [website, mastodon, linkedin, github]
 
   components:
     intro:
       text: "Why bagyo?"
-      href: "articles/bagyo.html"
+      href: articles/bagyo.html
     articles:
       text: Articles
       menu:
       - text: "Data Wrangling and Visualisation"
         href: articles/visualisation.html
+    # website:
+    #   icon: "fa-regular fa-globe fa-lg"
+    #   href: https://ernest.guevarra.io
     # mastodon:
     #   icon: "fab fa-mastodon fa-lg"
-    #   href: http://twitter.com/OxIHTM
+    #   href: https://fosstodon.org/@ernestguevarra
     # linkedin:
     #   icon: "fab fa-linkedin fa-lg"
-    #   href: https://www.linkedin.com/company/international-health-and-tropical-medicine
+    #   href: https://www.linkedin.com/in/ernestguevarra
 
 
 reference: