First, this package doesn’t do much except add a template Github Action to build all the pieces necessary for a workshop.
.github/workflows yaml fileas needed)
To accomplish this follow each of the 7 steps below. Once your edit the yaml files, Github actions will run each time you commit to github and will create for you:
Clone this repo, fork and rename it,
(PREFERRED) create a repo from this template
Depends: Biobase Suggests: knitr, rmarkdown, pkgdown If your packages
depend on a github R repos, be sure to specify the correct repo
username/reponame. Installation will deal with this.
In your repository, click on settings or url https://github.com/*GITHUB_USERNAME*/*REPO_NAME*/settings. Midway down the page, in the GitHub Pages section, select source ‘gh-pages branch’. If only ‘master branch’ is visible, select master for now, but once Github actions runs, ‘gh-pages branch’ will be available and is required to render the website.
In the DESCRIPTION file, update the URL: to the website url eg https://seandavi.github.io/BuildABiocWorkshop/ (but substitute your own repo, etc.)
Edit the file _pkgdown.yml, updating the url:, title and href: which should be your website url, title of your workshop and github repos url respectively. You do not need to edit this file further. You do not need to add menus or links to vignettes. GitHub Actions and pkgdown will do this when it builds the website
You do not need to create a docker image manually. Github actions
will read Dockerfile located in this template, and using the yaml files
will create, build and push to the Github Container Registry an image
with the name (default)
In the DESCRIPTION file, the DockerImage: should match your the docker image name (should be lowercase).
Edit the README.md. and add one or more Rmd vignettes that will
constitute the workshop materials. It is normal R package that should
rcmdcheck::rcmdcheck(), and be installed using regular
R package install commands.