doc: update doc before submit a new version to CRAN (ideas-lab-nus#83)

* doc: fix link errors * doc: add `CITATION` file * doc: fix test coverage workflow file
KornkamonTantiwanit · Mar 10, 2024 · 6763e75 · 6763e75
1 parent 0a545f8
commit 6763e75
Show file tree

Hide file tree

Showing 8 changed files with 36 additions and 16 deletions.
diff --git a/.github/workflows/test-coverage.yaml b/.github/workflows/test-coverage.yaml
@@ -21,7 +21,7 @@ jobs:
 
       - uses: r-lib/actions/setup-r@v2
         with:
-          r-version: ${{ matrix.config.r }}
+          r-version: "release"
           use-public-rspm: true
 
       - uses: r-lib/actions/setup-pandoc@v2

diff --git a/DESCRIPTION b/DESCRIPTION
@@ -48,7 +48,7 @@ Encoding: UTF-8
 URL: https://github.com/ideas-lab-nus/epwshiftr
 BugReports: https://github.com/ideas-lab-nus/epwshiftr/issues
 Roxygen: list(markdown = TRUE)
-RoxygenNote: 7.2.1
+RoxygenNote: 7.2.3
 Collate:
     'coord.R'
     'dict.R'

diff --git a/R/dict.R b/R/dict.R
@@ -13,8 +13,7 @@
 #' most of the CMIP6-endorsed model intercomparison projects (MIPs) and
 #' quantities that are more specialized and only of interest to a single
 #' endorsed MIP. The raw data of DReq is stored a Microsoft Excel file
-#' (`CMIP6_MIP_tables.xlsx`) in a
-#' [Subversion repo](http://proj.badc.rl.ac.uk/svn/exarch/CMIP6dreq/trunk).
+#' (`CMIP6_MIP_tables.xlsx`) in a Subversion repo.
 #' The `Cmip6Dict` object uses the parsed DReq data that is stored in the
 #' [GitHub Repo](https://github.com/PCMDI/cmip6-cmor-tables).
 #'

diff --git a/README.Rmd b/README.Rmd
@@ -36,7 +36,7 @@ file.copy(file.path("/mnt/d/ScenarioMIP", f), tempdir())
 <!-- badges: start -->
 [![R build status](https://github.com/ideas-lab-nus/epwshiftr/workflows/R-CMD-check/badge.svg)](https://github.com/ideas-lab-nus/epwshiftr/actions)
 [![CRAN status](https://www.r-pkg.org/badges/version/epwshiftr)](https://CRAN.R-project.org/package=epwshiftr)
-[![Codecov test coverage](https://codecov.io/gh/ideas-lab-nus/epwshiftr/branch/master/graph/badge.svg)](https://codecov.io/gh/ideas-lab-nus/epwshiftr?branch=master)
+[![Codecov test coverage](https://codecov.io/gh/ideas-lab-nus/epwshiftr/branch/master/graph/badge.svg)](https://app.codecov.io/gh/ideas-lab-nus/epwshiftr?branch=master)
 [![CRAN Download Badge](https://cranlogs.r-pkg.org/badges/epwshiftr)](https://cran.r-project.org/package=epwshiftr)
 <!-- badges: end -->
 
@@ -260,12 +260,12 @@ Hongyuan Jia and Adrian Chong
 ## Disclaimer
 
 CMIP6 model data is licensed under a [Creative Commons Attribution-ShareAlike
-4.0 International License](https://creativecommons.org/licenses).
-Consult [Terms of Use](https://pcmdi.llnl.gov/CMIP6/TermsOfUse) for terms of use
+4.0 International License](https://creativecommons.org/licenses/).
+Consult [Terms of Use](https://pcmdi.llnl.gov/CMIP6/TermsOfUse/) for terms of use
 governing CMIP6 output, including citation requirements and proper
 acknowledgment. Further information about each GCM output data, including some
 limitations, can be found via the `further_info_url` (recorded as a **global
-attribute** in the NetCDF file) and at [EC-Earth](http://www.ec-earth.org). The
+attribute** in the NetCDF file) and at [EC-Earth](https://www.ec-earth.org). The
 data producers and data providers make no warranty, either express or implied,
 including, but not limited to, warranties of merchantability and fitness for a
 particular purpose. All liabilities arising from the supply of the information

diff --git a/README.md b/README.md
@@ -9,7 +9,7 @@
 [![CRAN
 status](https://www.r-pkg.org/badges/version/epwshiftr)](https://CRAN.R-project.org/package=epwshiftr)
 [![Codecov test
-coverage](https://codecov.io/gh/ideas-lab-nus/epwshiftr/branch/master/graph/badge.svg)](https://codecov.io/gh/ideas-lab-nus/epwshiftr?branch=master)
+coverage](https://codecov.io/gh/ideas-lab-nus/epwshiftr/branch/master/graph/badge.svg)](https://app.codecov.io/gh/ideas-lab-nus/epwshiftr?branch=master)
 [![CRAN Download Badge](https://cranlogs.r-pkg.org/badges/epwshiftr)](https://cran.r-project.org/package=epwshiftr)
 <!-- badges: end -->
 
@@ -504,12 +504,12 @@ Hongyuan Jia and Adrian Chong
 ## Disclaimer
 
 CMIP6 model data is licensed under a [Creative Commons Attribution-ShareAlike
-4.0 International License](https://creativecommons.org/licenses).
-Consult [Terms of Use](https://pcmdi.llnl.gov/CMIP6/TermsOfUse) for terms of use
+4.0 International License](https://creativecommons.org/licenses/).
+Consult [Terms of Use](https://pcmdi.llnl.gov/CMIP6/TermsOfUse/) for terms of use
 governing CMIP6 output, including citation requirements and proper
 acknowledgment. Further information about each GCM output data, including some
 limitations, can be found via the `further_info_url` (recorded as a **global
-attribute** in the NetCDF file) and at [EC-Earth](http://www.ec-earth.org). The
+attribute** in the NetCDF file) and at [EC-Earth](https://www.ec-earth.org). The
 data producers and data providers make no warranty, either express or implied,
 including, but not limited to, warranties of merchantability and fitness for a
 particular purpose. All liabilities arising from the supply of the information

diff --git a/inst/CITATION b/inst/CITATION
@@ -0,0 +1,22 @@
+citHeader("To cite epwshiftr in publications use:")
+
+bibentry(
+    bibtype  = "Proceedings",
+    title = "Epwshiftr: Incorporating Open Data of Climate Change Prediction into Building Performance Simulation for Future Adaptation and Mitigation",
+    shorttitle = "Epwshiftr",
+    booktitle = "Proceedings of {{Building Simulation}} 2023: 18th Conference of IBPSA",
+    author = c(person("Hongyuan", "Jia"), person("Adrian", "Chong"), person("Baisong", "Ning")),
+    editor = "International Building Performance Simulation Association (IBPSA)",
+    year = "2023",
+    date = "2023-09-04/2023-09-06",
+    volume = "18",
+    pages = "3201-3207",
+    address = "Shanghai, China",
+    url = "https://CRAN.R-project.org/package=epwshiftr",
+    doi = "10.26868/25222708.2023.1612",
+    textVersion = paste("Jia, Hongyuan, Chong, Adrian, Ning, Baisong, 2023.",
+                        "Epwshiftr: incorporating open data of climate change prediction into building performance simulation for future adaptation and mitigation,",
+                        "in: Proceedings of Building Simulation 2023: 18th Conference of IBPSA, Building Simulation.",
+                        "Presented at the Building Simulation 2023, IBPSA, Shanghai, China, pp. 3201–3207.",
+                        "https://doi.org/10.26868/25222708.2023.1612")
+)
diff --git a/man/CMIP6Dict.Rd b/man/CMIP6Dict.Rd
diff --git a/vignettes/paper.bib b/vignettes/paper.bib
@@ -38,7 +38,7 @@ @article{jentsch2008
 	pages = {2148--2168},
 	volume = {40},
 	number = {12},
-	doi = {10/b4n9qc},
+	doi = {10.1016/J.ENBUILD.2008.06.005},
 	url = {https://linkinghub.elsevier.com/retrieve/pii/S0378778808001400},
 	note = {00297},
 	langid = {en}
@@ -117,7 +117,7 @@ @article{belcher2005
 	pages = {49--61},
 	volume = {26},
 	number = {1},
-	doi = {10/b4z2gp},
+	doi = {10.1191/0143624405BT112OA},
 	url = {http://journals.sagepub.com/doi/10.1191/0143624405bt112oa},
 	note = {00410},
 	langid = {en}