Merge pull request #41 from cct-datascience/citation

Add Citation

.Rbuildignore

@@ -7,3 +7,4 @@
 ^codecov\.yml$
 ^doc$
 ^Meta$
+^CITATION\.cff$

CITATION.cff

@@ -0,0 +1,27 @@
+# -----------------------------------------------------------
+# CITATION file created with {cffr} R package, v0.4.1
+# See also: https://docs.ropensci.org/cffr/
+# -----------------------------------------------------------
+
+cff-version: 1.2.0
+message: 'To cite package "azmetr" in publications use:'
+type: software
+license: MIT
+title: 'azmetr: Access Arizona weather data from the AZMet API'
+version: 0.1.1
+year: 2023
+abstract: Provides R functions to access the Arizona Meterological Network (AZMet)
+  API. Functions are more than just "thin wrappers" and do some parsing of input parameters
+  and wrangling of output data.
+authors:
+- family-names: Scott
+  given-names: Eric R.
+  email: [email protected]
+  orcid: https://orcid.org/0000-0002-7430-7879
+repository-code: https://github.com/cct-datascience/azmetr
+url: https://github.com/cct-datascience/azmetr
+contact:
+- family-names: Scott
+  given-names: Eric R.
+  email: [email protected]
+  orcid: https://orcid.org/0000-0002-7430-7879

DESCRIPTION

@@ -1,6 +1,6 @@
 Package: azmetr
-Title: Access the AZMet API
-Version: 0.1.0.9000
+Title: Access Arizona weather data from the AZMet API
+Version: 0.1.1
 Authors@R: 
     person("Eric", "Scott", , "[email protected]", role = c("aut", "cre"),
            comment = c(ORCID = "0000-0002-7430-7879"))

NEWS.md

@@ -1,4 +1,4 @@
-# azmetr (development version)
+# azmetr 0.1.1
 
 - `azmetr` now uses the `httr2` package instead of `httr` for API requests. This change allowed for easier rate limiting
 - There is now a rate limit of 4 requests per second to the API.  This shouldn't cause noticible slowdowns except when using the `station_id` argument maybe

R/release_questions.R

@@ -1,6 +1,7 @@
 release_bullets <- function() {
   c(
     "[Pre-compute vignettes](https://ropensci.org/blog/2019/12/08/precompute-vignettes/)",
-    "Check that only magrittr pipe (`%>%`) and not base pipe (`|>`) is used"
+    "Check that only magrittr pipe (`%>%`) and not base pipe (`|>`) is used",
+    "Update CITATION.cff and inst/CITATION"
   )
 }

inst/CITATION

@@ -0,0 +1,26 @@
+citHeader("To cite azmetr in publications please cite both the R package and the data source:")
+
+citEntry(
+  entry    = "Misc",
+  title    = "azmetr: Access Arizona weather data from the AZMet API",
+  author   = c(person(given = c("Eric", "R."),
+                      family = "Scott",
+                      role = c("aut", "cre"),
+                      email = "[email protected]")),
+  year     = "2023",
+  version = as.package_version("0.1.1"),
+  url = "https://github.com/cct-datascience/azmetr",
+  textVersion = paste(
+    'Scott ER (2023). “azmetr: Access Arizona weather data from the AZMet API.”'
+  )
+)
+
+citEntry(
+  entry = "Misc",
+  title = "Arizona Meteorological Network (AZMet) Data. Accessed <date accessed>",
+  author = "Arizona Meteorological Network",
+  url = "https://azmet.arizona.edu",
+  textVersion = "Arizona Meteorological Network, Arizona Meteorological Network (AZMet) Data. Accessed <date accessed>, https://azmet.arizona.edu"
+)
+
+