Title: Curriculum Vitae for R Markdown
Version: 0.6.0
Description: Provides templates and functions to simplify the production and maintenance of curriculum vitae.
Depends: R (≥ 3.5.0)
Imports: rlang, glue, dplyr, rmarkdown (≥ 2.2), knitr, xfun, yaml, tibble, vctrs (≥ 0.3.3), pillar, jsonlite
Suggests: covr, testthat, stringr, htmltools
SystemRequirements: pandoc (>= 2.7) - http://pandoc.org
License: GPL-3
Encoding: UTF-8
BugReports: https://github.com/mitchelloharawild/vitae/issues
URL: https://pkg.mitchelloharawild.com/vitae/, https://github.com/mitchelloharawild/vitae
RoxygenNote: 7.3.1
VignetteBuilder: knitr
NeedsCompilation: no
Packaged: 2024-06-12 19:01:33 UTC; mitchell
Author: Mitchell O'Hara-Wild ORCID iD [aut, cre], Rob Hyndman ORCID iD [aut], Yihui Xie ORCID iD [ctb], Albert Krewinkel [cph] (Multiple bibliographies lua filter), JooYoung Seo ORCID iD [ctb], Isabelle Greco ORCID iD [ctb]
Maintainer: Mitchell O'Hara-Wild <mail@mitchelloharawild.com>
Repository: CRAN
Date/Publication: 2024-06-12 19:10:02 UTC

vitae: Curriculum Vitae for R Markdown

Description

logo

Provides templates and functions to simplify the production and maintenance of curriculum vitae.

Author(s)

Maintainer: Mitchell O'Hara-Wild mail@mitchelloharawild.com (ORCID)

Authors:

Other contributors:

See Also

Useful links:

Awesome CV template

Description

Awesome CV is LaTeX template for a CV or Résumé inspired by Fancy CV: https://github.com/posquit0/Awesome-CV

Usage

awesomecv(
  ...,
  latex_engine = "xelatex",
  page_total = FALSE,
  show_footer = TRUE
)

Arguments

...

Arguments passed to cv_document.

latex_engine

LaTeX engine for producing PDF output. Options are "pdflatex", "lualatex", "xelatex" and "tectonic".

page_total

If TRUE, the total number of pages is shown in the footer.

show_footer

If TRUE, a footer showing your name, document name, and page number.

Value

An R Markdown output format object.

Preview

Template preview

Author(s)

Mitchell O'Hara-Wild, theme by Byungjin Park (@posquit0)

Print bibliography section

Description

Given a bibliography file, this function will generate bibliographic entries for one or more types of bib entry.

Usage

bibliography_entries(file, startlabel = NULL, endlabel = NULL)

Arguments

file

A path to a bibliography file understood by rmarkdown::pandoc_citeproc_convert().

startlabel

Defunct.

endlabel

Defunct.

Value

A dataset representing the bibliographic entries, suitable for generating a reference section in a document.

Author(s)

Mitchell O'Hara-Wild & Rob J Hyndman

Examples


# Create a bibliography from a set of packages
bib <- tempfile(fileext = ".bib")
knitr::write_bib(c("vitae", "tibble"), bib)

# Import the bibliography entries into a CV
bibliography_entries(bib)

# The order of these entries can be customised using `dplyr::arrange()`
bibliography_entries(bib) %>%
  arrange(desc(title))

# For more complex fields like author, you can also sort by component fields.
# For example, use `author$family` to sort by family names.
bibliography_entries(bib) %>%
  arrange(desc(author$family))

CV entries

Description

This function accepts a data object (such as a tibble) and formats the output into a suitable format for the template used. The inputs can also involve further calculations, which will be done using the provided data.

Usage

brief_entries(data, what, when, with, .protect = TRUE)

detailed_entries(data, what, when, with, where, why, .protect = TRUE)

Arguments

data

A data.frame or tibble.

what

The primary value of the entry (such as workplace title or degree).

when

The time of the entry (such as the period spent in the role).

with

The company or organisation.

.protect

When TRUE, inputs to the previous arguments will be protected from being parsed as LaTeX code.

where

The location of the entry.

why

Any additional information, to be included as dot points. Multiple dot points can be provided via a list column. Alternatively, if the same what, when, with, and where combinations are found in multiple rows, the why entries of these rows will be combined into a list.

Details

All non-data inputs are optional, and will result in an empty space if omitted.

Examples

packages_used <- tibble::tribble(
  ~ package, ~ date, ~ language, ~ timezone, ~ details,
  "vitae", Sys.Date(), "R", Sys.timezone(), c("Making my CV with vitae.", "Multiple why entries."),
  "rmarkdown", Sys.Date()-10, "R", Sys.timezone(), "Writing reproducible, dynamic reports using R."
)
packages_used %>%
  detailed_entries(what = package, when = date, with = language, where = timezone, why = details)

A date conforming to the CSL schema

Description

This class provides helper utilities to display, sort, and select attributes from a date in the CSL format.

Usage

csl_date(
  date_parts = list(),
  season = NULL,
  circa = NULL,
  literal = NULL,
  raw = NULL,
  edtf = NULL
)

csl_dates(x = list())

Arguments

date_parts

A list containing one or two dates in a list. Each date is also represented using lists in the format of list(year, month, day). Different precision can be achieved by providing an incomplete list: list(year, month). A range of dates can be specified by providing two dates, where the first date is the start and second date is the end of the interval.

season, circa, literal, raw, edtf

Additional date variable properties as described in the schema.

x

A list of csl_date() values.

See Also

https://citeproc-js.readthedocs.io/en/latest/csl-json/markup.html#date-fields

Examples

# Single date
csl_date(date_parts = list(list(2020,03,05)))
# Date interval
csl_date(date_parts = list(list(2020,03,05), list(2020,08,25)))

A name variable conforming to the CSL schema

Description

This class provides helper utilities to display, sort, and select attributes from a name in the CSL format.

Usage

csl_name(
  family = NULL,
  given = NULL,
  dropping_particle = NULL,
  non_dropping_particle = NULL,
  suffix = NULL,
  comma_suffix = NULL,
  static_ordering = NULL,
  literal = NULL,
  parse_names = NULL
)

csl_names(x = list())

list_of_csl_names(x = list())

Arguments

family

The family name

given

The given name

dropping_particle, non_dropping_particle, suffix, comma_suffix, static_ordering, literal, parse_names

Additional name variable properties as described in the schema.

x

For csl_name(), x should be a list of csl_name(). For list_of_csl_names(), x should be a list of csl_names().

See Also

https://citeproc-js.readthedocs.io/en/latest/csl-json/markup.html#name-fields

Output format for vitae

Description

This output format provides support for including LaTeX dependencies and bibliography entries in extension of the rmarkdown::pdf_document() format.

Usage

cv_document(
  ...,
  pandoc_args = NULL,
  pandoc_vars = NULL,
  base_format = rmarkdown::pdf_document
)

Arguments

...

Arguments passed to rmarkdown::pdf_document().

pandoc_args

Additional command line options to pass to pandoc

pandoc_vars

Pandoc variables to be passed to the template.

base_format

An output format function to be used as the base format.

Hyndman CV template

Description

Produces a CV using the style used in Rob Hyndman's CV: https://robjhyndman.com/hyndsight/cv/

Usage

hyndman(...)

Arguments

...

Arguments passed to cv_document.

Value

An R Markdown output format object.

Preview

Template preview

Author(s)

Rob J Hyndman & Mitchell O'Hara-Wild

Include a preview of the CV template output for documentation

Description

Include a preview of the CV template output for documentation

Usage

insert_preview(template)

Arguments

template

Name of the template

latexcv cv and resume templates

Description

A collection of simple and easy to use, yet powerful LaTeX templates for CVs and resumes: https://github.com/jankapunkt/latexcv

Usage

latexcv(..., theme = c("classic", "modern", "rows", "sidebar", "two_column"))

Arguments

...

Arguments passed to cv_document.

theme

The theme used for the template (previews in link above).

Value

An R Markdown output format object.

Preview

Template preview

Author(s)

Mitchell O'Hara-Wild, themes by Jan Küster (@jankapunkt)

Eliseo Papa's markdown-cv template

Description

Produces a CV in the HTML format using various styles of the markdown-cv template: https://github.com/elipapa/markdown-cv

Usage

markdowncv(..., theme = c("kjhealy", "blmoore", "davewhipp", "ccbaumler"))

Arguments

...

Arguments passed to cv_document.

theme

The style used in the CV (matches the prefix of CSS files). The "kjhealy" theme is inspired by @kjhealy's vita template, "blmoore" is from @blmoore's md-cv template, and "davewhipp" is @davewhipp's theme which notably has dates right aligned.

Value

An R Markdown output format object.

Preview

Template preview

Author(s)

Mitchell O'Hara-Wild, theme by Eliseo Papa (@elipapa)

Moderncv template

Description

Moderncv provides a documentclass for typesetting curricula vitae in various styles. Moderncv aims to be both straightforward to use and customizable, providing five ready-made styles (classic, casual, banking, oldstyle and fancy): https://github.com/xdanaux/moderncv

Usage

moderncv(
  ...,
  theme = c("casual", "classic", "oldstyle", "banking", "fancy"),
  latex_engine = "xelatex"
)

Arguments

...

Arguments passed to cv_document.

theme

The theme used for the template.

latex_engine

LaTeX engine for producing PDF output. Options are "pdflatex", "lualatex", "xelatex" and "tectonic".

Value

An R Markdown output format object.

Preview

Template preview

Author(s)

Mitchell O'Hara-Wild, theme by Xavier Danaux (@xdanaux)

Objects exported from other packages

Description

These objects are imported from other packages. Follow the links below to see their documentation.

dplyr

%>%, arrange, distinct, filter, group_by, mutate, rename, select, slice, summarise, transmute

Twenty Seconds CV template

Description

A curriculum vitae, otherwise known as a CV or résumé, is a document used by individuals to communicate their work history, education and skill set. This is a style template for your curriculum written in LaTex. The main goal of this template is to provide a curriculum that is able to survive to the résumés screening of "twenty seconds": https://github.com/spagnuolocarmine/TwentySecondsCurriculumVitae-LaTex

Usage

twentyseconds(...)

Arguments

...

Arguments passed to cv_document.

Value

An R Markdown output format object.

Preview

Template preview

Author(s)

Mitchell O'Hara-Wild, theme by Carmine Spagnuolo (@spagnuolocarmine)