Skip to content

Commit

Permalink
update package
Browse files Browse the repository at this point in the history
  • Loading branch information
svmiller committed Aug 21, 2024
1 parent a2363ad commit 546ebc2
Show file tree
Hide file tree
Showing 9 changed files with 809 additions and 12 deletions.
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,6 @@ License: GPL-2
Encoding: UTF-8
Imports:
rmarkdown
RoxygenNote: 7.2.3
RoxygenNote: 7.3.1
Suggests:
testthat
3 changes: 2 additions & 1 deletion NEWS.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
# stevetemplates 1.1.0

- `word` now has a custom footnote style, which simply decreases the font size from 12 to 9.
- `article3` no longer has a hypothesis theorem hard-coded to it. `{bookdown}` can do that, if you need it. Rationale: you also won't need it for the simplest of simple cases, or could add one yourself by way of `header-includes:`.
- `article3` no longer has a hypothesis theorem hard-coded to it. `{bookdown}` can do that, if you need it. Rationale: you also won't need it for the simplest of simple cases, or could add one yourself by way of `header-includes:`.
- `cv2` is an updated version of `cv`, which I use now for my academic CV.

# stevetemplates 1.0.0

Expand Down
10 changes: 5 additions & 5 deletions R/article3.R
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@
#' primer on this tutorial is available on my website
#' <http://svmiller.com/blog/2023/05/a-third-rmarkdown-article-manuscript-template/>.
#'
#' If your version of TeX comes by way of Yihui Xie's \pkg{tinytex}, you'll want to
#' additionally install the "xurl" library. Otherwise, you'll get a vague error about a
#' missing LaTeX dependency. \code{tinytex::tlmgr_install("xurl")} should suffice. I
#' thank Ian Adams and Cornelius Hennch for finding this issue and pointing to this
#' solution.
#' If your version of TeX comes by way of Yihui Xie's \pkg{tinytex}, you'll want
#' to additionally install the "xurl" library. Otherwise, you'll get a vague
#' error about a missing LaTeX dependency. \code{tinytex::tlmgr_install("xurl")}
#' should suffice. I thank Ian Adams and Cornelius Hennch for finding this issue
#' and pointing to this solution.
#'
#' # About YAML header fields
#'
Expand Down
63 changes: 63 additions & 0 deletions R/cv2.R
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
#' Steve's Second Academic CV Template
#'
#' A template for academic CVs. This is an evolution of the first one, though
#' has slightly different aesthetic features you can see for yourself. For more
#' information, see here: <http://svmiller.com/blog/2016/03/svm-r-markdown-cv/>.
#' You can also check my current CV.
#'
#' # About YAML header fields
#'
#' This section documents some of the YAML fields to know
#' for this template.
#'
#'
#' | FIELD | DESCRIPTION |
#' | ------ | ----------- |
#' | `author` | name of the author |
#' | `jobtitle` | appears as first row in the CV |
#' | `address` |appears as second row in the CV |
#' | `fontawesome` | logical, defaults to `TRUE`. If `TRUE`, use fontawesome icons |
#' | `email` | your email, for the third row |
#' | `github` | optional, displays Github user name on third row |
#' | `orcid` | optional, displays ORCID ID on third row |
#' | `phone` | optional, displays your phone number on third row |
#' | `web` | optional, displays your domain name on third row |
#' | `updated` | optional, displays (on third row) when file was last updated. If FALSE or omitted, date of update is communicated in footer |
#' | `rdateformat` | optional, but takes R syntax to format date of update. |
#' | `keywords` | not terribly useful, but some keywords to embed in PDF so Google may find it |
#'
#' # Additional Comments
#'
#' The `fontawesome` argument calls the `fontawesome5` package in LaTeX. This
#' assumes the use of TeXLive 2015 at the latest.
#'
#' `latex_engine` is hard-set as "xelatex". This permits greater flexibility in
#' use of fonts through the `mainfont` argument you can specify in the YAML.
#'
#' I'll be frank that disabling `fontawesome` doesn't make much sense to me,
#' though the option is there if you want it. The CV just won't look as nice
#' with it disabled.
#'
#' `fontawesome` controls the use of icons in the header, though icons for
#' ORCID and OSF come from the `academicicons` package. Everything else comes
#' from `fontawesome5`.
#'
#' @inheritParams rmarkdown::pdf_document
#' @param ... Arguments to [`rmarkdown::pdf_document`].
#' @md
#' @export
#'

cv2 <- function(...){
templ <- system.file("rmarkdown", "templates", "cv2", "resources", "template.tex", package = "stevetemplates")
rmarkdown::pdf_document(template = templ,
latex_engine = "xelatex",
...)
}


#' @rdname cv2
#' @export
templ_cv2 <- function() {
print(system.file("rmarkdown", "templates", "cv2", "resources", "template.tex", package = "stevetemplates"))
}
Loading

0 comments on commit 546ebc2

Please sign in to comment.