diff --git a/.github/workflows/check-qmd-render.yaml b/.github/workflows/check-qmd-render.yaml new file mode 100644 index 0000000..09033dc --- /dev/null +++ b/.github/workflows/check-qmd-render.yaml @@ -0,0 +1,39 @@ +name: Check whether the files render +on: + push: + branches: + - main + +jobs: + render-slides: + runs-on: ubuntu-latest + + strategy: + matrix: + file: + - slides + - report + + container: + image: rocker/tidyverse:4.4.0 + + steps: + # Check out the repository (git clone) + - uses: actions/checkout@v4 + + # Install dependencies (R packages) + - name: Install dependencies + run: | + install2.r data.table slurmR epiworldR + + # Render the slides/report using quarto + - name: Render ${{ matrix.file }} + run: | + quarto render ${{ matrix.file }}.qmd --to html + + # Save the rendered slides/report as an artifact + - name: Save as artifact + uses: actions/upload-artifact@v4 + with: + path: ${{ matrix.file }}.html + name: ${{ matrix.file }} diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..b7597b3 --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +*_cache +*_files \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..38203bf --- /dev/null +++ b/README.md @@ -0,0 +1,28 @@ +# Template project for Advanced Programming [![Slides and report render](../../actions/workflows/check-qmd-render.yaml/badge.svg)](../../actions/workflows/check-qmd-render.yaml) + +The template project has the following files: + +- `README.md`: this file. +- `data/`: a folder for data files. +- `.gitignore`: a file that tells git which files to ignore. +- `slides.qmd`: a presentation in quarto format. +- `report.qmd`: a report in quarto format. +- `.github/workflows/check-qmd-render.yaml`: The workflow that builds the html and pdf files. New dependencies can be added on the step "Install dependencies"; the following installs the R packages data.table and slurmR from CRAN: + + ```yaml + - name: Install dependencies + run: | + install2.r data.table slurmR + ``` + + This workflow should complete without errors before you submit your project. + +## Instructions + +1. Use the qmd files to write your report and slides. + +2. Add any needed files (figures, C++, data, etc.) to the repository. + +2. If needed, add additional dependencies to the workflow file. + +3. Ensure the [report.pdf](report.pdf) and [slides.html](slides.html) files are generated. diff --git a/data/README.md b/data/README.md new file mode 100644 index 0000000..1c31e49 --- /dev/null +++ b/data/README.md @@ -0,0 +1,3 @@ +# Data folder + +Any data your project holds should go here. \ No newline at end of file diff --git a/report.pdf b/report.pdf new file mode 100644 index 0000000..4510e68 Binary files /dev/null and b/report.pdf differ diff --git a/report.qmd b/report.qmd new file mode 100644 index 0000000..448bccf --- /dev/null +++ b/report.qmd @@ -0,0 +1,15 @@ +--- +format: pdf +author: John Doe +title: My fancy presentation +subtitle: For PHS 7045 +--- + +# Section 1 + +## Sub-section 1 + +```{r} +#| label: some-code +library(MASS) +``` \ No newline at end of file diff --git a/slides.html b/slides.html new file mode 100644 index 0000000..6d89aa3 --- /dev/null +++ b/slides.html @@ -0,0 +1,2474 @@ + +
+ + + + + + + + + + + +