Merge pull request #17 from jhollway/develop

Improvements to syllabus_pdf and template

.github/workflows/build.yml → .github/workflows/prchecks.yml

@@ -70,4 +70,6 @@ jobs:
           dir.create("build")
           file.copy(binary, "build")
         shell: Rscript {0}
-
+
+      - name: Calculate code coverage
+        run: Rscript -e "covr::codecov()"

.github/workflows/package.yml → .github/workflows/pushrelease.yml

@@ -77,6 +77,9 @@ jobs:
           name: ${{ matrix.config.asset_name }}
           path: build/
 
+      - name: Calculate code coverage
+        run: Rscript -e "covr::codecov()"
+
   release:
     name: Bump version and release
     needs: build

DESCRIPTION

@@ -1,7 +1,7 @@
 Package: iheiddown
 Title: A RMarkdown class for IHEID documents
-Date: 2020-07-15
-Version: 0.5.1
+Date: 2020-08-10
+Version: 0.6.0
 Authors@R: 
     c(person(given = "James",
            family = "Hollway",
@@ -13,8 +13,10 @@ Description: This package supports writing dissertations, theses, and syllabi
     according to the Graduate Institute of International and Development Studies 
     regulations.
 License: MIT
-Imports: bookdown, tidyverse, roxygen2
+Imports: bookdown, tidyverse, roxygen2, citr, covr
 Encoding: UTF-8
 LazyData: true
 Roxygen: list(markdown = TRUE)
 RoxygenNote: 7.1.1
+Suggests: 
+    testthat

NAMESPACE

@@ -1,5 +1,6 @@
 # Generated by roxygen2: do not edit by hand
 
+export(advdate)
 export(syllabus_pdf)
 export(thesis_pdf)
 importFrom(utils,file.edit)

NEWS.md

@@ -1,3 +1,18 @@
+# iheiddown 0.6.0
+
+* Set up `testthat` for package
+* Added `advdate()` for incrementing dates by week
+  * Updated syllabus template for `advdate()`
+  * Added test for `advdate()`
+* Added `chicago-syllabus.csl`
+  * No more reliance on `RefManageR`
+  * Imports `citr`, not strictly a dependence but highly recommended
+  * No bibliography at end of document
+  * Updated syllabus template for `chicago-syllabus.csl`
+* Using second-level numbering for subsections in syllabus `template.tex`
+* Added draft: true option in YAML
+* Added codecov checks to github actions .yml
+
 # iheiddown 0.5.1
 
 * Fixed `front-matter/` error

R/dates.R

@@ -0,0 +1,15 @@
+#' Advance dates by week
+#'
+#' @description This function takes a start date, e.g. of a course,
+#' and advances it by a number of weeks.
+#' This function is used in the syllabus template.
+#' 
+#' @param startdate The first date in the series (e.g. first day of class)
+#' @param week The number of weeks into the series
+#' 
+#' @export
+advdate <- function(startdate, week) {
+  zadv <- as.Date(startdate) + 7*(week-1)
+  tmp <- paste0("(", trimws(format(zadv, format="%e %b")), ")")
+  return(tmp)
+}

README.md

@@ -5,6 +5,7 @@
 ![GitHub Release Date](https://img.shields.io/github/release-date/jhollway/iheiddown)
 ![GitHub issues](https://img.shields.io/github/issues-raw/jhollway/iheiddown)
 [![HitCount](http://hits.dwyl.com/jhollway/iheiddown.svg)](http://hits.dwyl.com/jhollway/iheiddown)
+[![Codecov test coverage](https://codecov.io/gh/jhollway/iheiddown/branch/master/graph/badge.svg)](https://codecov.io/gh/jhollway/iheiddown?branch=master)
 <!-- ![GitHub All Releases](https://img.shields.io/github/downloads/jhollway/iheiddown/total) -->
 <!-- badges: end -->
 
@@ -134,7 +135,8 @@ This will format the chapter in the myiheidtex style but without including the f
 ## Output 
 
 All your front matter and chapters of your thesis will be compiled
-and the complete product can be found under the project folder: "docs/_main.pdf".
+and the complete product can be found under the project folder "versions/".
+A date is automatically appended to the filename to assist with tracking versions.
 
 The PDF version is fully functional. 
 The word, gitbook and epub versions might be developed at a later time.