Merge branch 'statistical-models-ws' of https://github.com/EDUCE-UBC/educer into statistical-models-ws

Author: andr3wli

.Rbuildignore

@@ -1,3 +1,6 @@
 ^.*\.Rproj$
 ^\.Rproj\.user$
 ^data-raw$
+^\.github$
+CODEOWNERS
+CONTRIBUTING.md

.github/.gitignore

@@ -0,0 +1 @@
+*.html

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

@@ -0,0 +1,30 @@
+# For help debugging build failures open an issue on the RStudio community with the 'github-actions' tag.
+# https://community.rstudio.com/new-topic?category=Package%20development&tags=github-actions
+on:
+  push:
+    branches:
+      - main
+      - master
+  pull_request:
+    branches:
+      - main
+      - master
+
+name: R-CMD-check
+
+jobs:
+  R-CMD-check:
+    runs-on: macOS-latest
+    env:
+      GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
+    steps:
+      - uses: actions/checkout@v2
+      - uses: r-lib/actions/setup-r@v1
+      - name: Install dependencies
+        run: |
+          install.packages(c("remotes", "rcmdcheck"))
+          remotes::install_deps(dependencies = TRUE)
+        shell: Rscript {0}
+      - name: Check
+        run: rcmdcheck::rcmdcheck(args = "--no-manual", error_on = "error")
+        shell: Rscript {0}

.github/workflows/pkgdown.yaml

@@ -0,0 +1,49 @@
+on:
+  push:
+    branches:
+      - main
+      - master
+
+name: pkgdown
+
+jobs:
+  pkgdown:
+    runs-on: macOS-latest
+    env:
+      GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
+    steps:
+      - uses: actions/checkout@v2
+
+      - uses: r-lib/actions/setup-r@v1
+
+      - uses: r-lib/actions/setup-pandoc@v1
+
+      - name: Query dependencies
+        run: |
+          install.packages('remotes')
+          saveRDS(remotes::dev_package_deps(dependencies = TRUE), ".github/depends.Rds", version = 2)
+          writeLines(sprintf("R-%i.%i", getRversion()$major, getRversion()$minor), ".github/R-version")
+        shell: Rscript {0}
+
+      - name: Cache R packages
+        uses: actions/cache@v2
+        with:
+          path: ${{ env.R_LIBS_USER }}
+          key: ${{ runner.os }}-${{ hashFiles('.github/R-version') }}-1-${{ hashFiles('.github/depends.Rds') }}
+          restore-keys: ${{ runner.os }}-${{ hashFiles('.github/R-version') }}-1-
+
+      - name: Install dependencies
+        run: |
+          remotes::install_deps(dependencies = TRUE)
+          install.packages("pkgdown", type = "binary")
+          install.packages("rsconnect", type = "binary")
+        shell: Rscript {0}
+
+      - name: Install package
+        run: R CMD INSTALL .
+
+      - name: Deploy package
+        run: |
+          git config --local user.email "[email protected]"
+          git config --local user.name "GitHub Actions"
+          Rscript -e 'pkgdown::deploy_to_branch(new_process = FALSE)'

CONTRIBUTING.md

@@ -0,0 +1,26 @@
+# Contributing to educer
+
+Thank you for taking the time to contribute to educer! 
+
+## What should I know before I get started?
+
+Please see our general resources for EDUCE contributors on our [EDUCE-UBC.github.io Wiki](https://github.com/EDUCE-UBC/EDUCE-UBC.github.io/wiki/Contributors).
+
+## Package conventions
+
+- Place any images in the `inst/resources/images/` folder.
+- If it does not exist yet, create an R setup code chunk in the `.Rmd` file of the learnr tutorial right after the yaml header.
+- Add the following line of code to the R setup code chunk:
+
+```
+library(educer)
+setup_resources()
+```
+
+- To add an image in the `.Rmd` file of the learnr tutorial, you can now give the path to an `image.ext` in `inst/resources/images/` like so (you MUST include the first `/`):
+
+```
+![](/images/image.ext)
+```
+
+- You can learn more about the helper function `setup_resources()` with `?setup_resources` and add other paths to resources (e.g. `resources/css/` is already established).

README.md

@@ -1,52 +1,31 @@
-
 # educer
 
 <!-- badges: start -->
-<!-- badges: end -->
 
-Please visit the EDUCE homepage for [install instructions of R and RStudio](https://educe-ubc.github.io/r_and_rstudio.html).
+[![R-CMD-check](https://github.com/EDUCE-UBC/educer/workflows/R-CMD-check/badge.svg)](https://github.com/EDUCE-UBC/educer/actions)
 
+<!-- badges: end -->
 
+Please visit the EDUCE homepage for [install instructions of R and RStudio](https://educe-ubc.github.io/r_and_rstudio.html).
 
 ## Installation
 
 You can install the released version of educer from GitHub with:
 
-``` r
+```
 if (!require(devtools)) install.packages("devtools")
 devtools::install_github("EDUCE-UBC/educer")
 ```
 
 See the EDUCE homepage for more detailed [install instructions](https://educe-ubc.github.io/educer.html).
 
-
-
 ## Loading and getting help on the educer package
 
-``` r
+```
 library(educer)
 ?educer
 ```
 
-
-
 ## Using the interactive tutorials
 
 Please the the EDUCE homepage for information on how to [start the tutorials](https://educe-ubc.github.io/tutorials.html).
-
-
-
-## For developers
-
-- Place any images in the `inst/resources/images/` folder
-- If it does not exist yet, create an r setup code chunk in the tutorial.Rmd file right after the yaml header
-- Add the following line of code to the r setup code chunk:
-
-```
-library(educer)
-setup_resources()
-```
-
-- To add an image in tutorial.Rmd, you can now give the path to an `image.ext` in `inst/resources/images/` like so (you MUST include the first `/`):
-![](/images/image.ext)
-- You can learn more about the helper function `setup_resources` with `?setup_resources` and add other paths to resources (css is already established).