Merge pull request #13 from cmu-delphi/use-delphidocs

Use delphidocs

Author: dajmcdon

.github/workflows/R-CMD-check.yaml

@@ -15,7 +15,7 @@ jobs:
       GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
       R_KEEP_PKG_SOURCE: yes
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - uses: r-lib/actions/setup-r@v2
         with:

.github/workflows/pkgdown.yaml

@@ -22,7 +22,7 @@ jobs:
     permissions:
       contents: write
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - uses: r-lib/actions/setup-pandoc@v2
 
@@ -41,7 +41,7 @@ jobs:
 
       - name: Deploy to GitHub pages 🚀
         if: github.event_name != 'pull_request'
-        uses: JamesIves/github-pages-deploy-action@v4.4.1
+        uses: JamesIves/github-pages-deploy-action@v4.5.0
         with:
           clean: false
           branch: gh-pages

.gitignore

@@ -2,5 +2,5 @@
 .Rhistory
 .RData
 .Ruserdata
-.DS_Store
+*.DS_Store
 docs

DESCRIPTION

@@ -3,20 +3,28 @@ Package: epidatasets
 Title: Epidemiological Data for Delphi Tooling Examples
 Version: 0.0.1
 Authors@R: c(
-    person(c("Daniel", "J."), "McDonald", email="[email protected]", role = c("aut")),
-    person("Nat", "DeFries", email="[email protected]", role = c("cre", "aut")),
-    person("Johns Hopkins University Center for Systems Science and Engineering", role = "dtc", comment = "Owner of COVID-19 cases and deaths data from the COVID-19 Data Repository"),
-    person("Johns Hopkins University", role = "cph", comment = "Copyright holder of COVID-19 cases and deaths data from the COVID-19 Data Repository"),
-    person("Carnegie Mellon University Delphi Group", role = "dtc", comment = "Owner of masking, social-distancing, and CLI data from the COVID-19 Trends and Impacts Survey. Owner of claims-based CLI data from the Delphi Epidata API"),
-    person("The COVID-19 Canada Open Data Working Group", role = "dtc", comment = "Owner of Canadian COVID-19 cases rates from the Covid19Canada data repository"),
-    person("Statistics Canada", role = "dtc", comment = "Owner of Canadian graduate employment income data from the Statistics Canada website"),
-    person("Google", role = "dtc", comment = "Collaborator on CLI data from the Google symptom surveys")
+    person(c("Daniel", "J."), "McDonald", , "[email protected]", role = "aut"),
+    person("Nat", "DeFries", , "[email protected]", role = c("cre", "aut")),
+    person("Johns Hopkins University Center for Systems Science and Engineering", role = "dtc",
+           comment = "Owner of COVID-19 cases and deaths data from the COVID-19 Data Repository"),
+    person("Johns Hopkins University", role = "cph",
+           comment = "Copyright holder of COVID-19 cases and deaths data from the COVID-19 Data Repository"),
+    person("Carnegie Mellon University Delphi Group", role = "dtc",
+           comment = "Owner of masking, social-distancing, and CLI data from the COVID-19 Trends and Impacts Survey. Owner of claims-based CLI data from the Delphi Epidata API"),
+    person("The COVID-19 Canada Open Data Working Group", role = "dtc",
+           comment = "Owner of Canadian COVID-19 cases rates from the Covid19Canada data repository"),
+    person("Statistics Canada", role = "dtc",
+           comment = "Owner of Canadian graduate employment income data from the Statistics Canada website"),
+    person("Google", role = "dtc",
+           comment = "Collaborator on CLI data from the Google symptom surveys")
   )
 Description: This package contains data sets used to compile vignettes and
     other documentation in Delphi R Packages. The goal is to avoid calls
     to the Delphi Epidata API, and to deposit some examples here for easy
     offline use.
-License: file LICENSE
+License: MIT + file LICENSE
+URL: https://github.com/cmu-delphi/epidatasets,
+    https://cmu-delphi.github.io/epidatasets/
 Depends:
     R (>= 2.10)
 Suggests: 
@@ -35,10 +43,11 @@ Enhances:
     epiprocess (>= 0.9.0),
     tibble
 Remotes:
+    cmu-delphi/delphidocs,
     cmu-delphi/epidatr,
     cmu-delphi/epiprocess
+Config/Needs/website: cmu-delphi/delphidocs
 Encoding: UTF-8
 LazyData: true
 Roxygen: list(markdown = TRUE)
 RoxygenNote: 7.3.2
-URL: https://cmu-delphi.github.io/epidatasets/

R/epidatasets-package.R

@@ -0,0 +1,6 @@
+#' @keywords internal
+"_PACKAGE"
+
+## usethis namespace: start
+## usethis namespace: end
+NULL

README.Rmd

@@ -29,8 +29,8 @@ examples here for easy offline use.
 You can install the development version of `{epidatasets}` like so:
 
 ``` r
-# install.packages("remotes")
-remotes::install_github("cmu-delphi/epidatasets")
+# install.packages("pak")
+pak::pkg_install("cmu-delphi/epidatasets")
 ```
 
 

README.md

@@ -17,8 +17,8 @@ Delphi Epidata API, and deposit some examples here for easy offline use.
 You can install the development version of `{epidatasets}` like so:
 
 ``` r
-# install.packages("remotes")
-remotes::install_github("cmu-delphi/epidatasets")
+# install.packages("pak")
+pak::pkg_install("cmu-delphi/epidatasets")
 ```
 
 ## Contents

_pkgdown.yml

@@ -1,24 +1,26 @@
 url: https://cmu-delphi.github.io/epidatasets/
+
 template:
-  bootstrap: 5
-  bootswatch: cosmo
-  bslib:
-    font_scale: 1.0
-    primary: '#C41230'
-    link-color: '#C41230'
-    navbar-bg: '#C41230'
-    navbar-fg: '#f8f8f8'
-navbar:
-  bg: '#C41230'
-  fg: '#f8f8f8'
+  package: delphidocs
+
+repo:
+  url:
+    home: https://github.com/cmu-delphi/epidatasets/
+    source: https://github.com/cmu-delphi/epidatasets/
+    issue: https://github.com/cmu-delphi/epidatasets/issues
+
 home:
-  links:
-  - text: The epiprocess R package
-    href: https://cmu-delphi.github.io/epiprocess/
-  - text: The epipredict R package
-    href: https://cmu-delphi.github.io/epipredict/
-  - text: The covidcast R package
-    href: https://cmu-delphi.github.io/covidcast/covidcastR/
-  - text: The epidatr R package
-    href: https://github.com/cmu-delphi/epidatr/
+  sidebar:
+    structure: [links, license, community, citation, authors, dev, related]
+    components:
+      related:
+        title: Delphi packages and resources
+        text: |
+          * [The epidatr package](https://github.com/cmu-delphi/epidatr/)
+          * [The epiprocess package](https://cmu-delphi.github.io/epiprocess/)
+          * [The epipredict package](https://cmu-delphi.github.io/epipredict)
+          * [Introduction to Delphi's Tooling Work](https://cmu-delphi.github.io/delphi-tooling-book/)
 
+reference:
+- title: Included data
+- contents: has_keyword("datasets")