Mitchell O'Hara-Wild

### Why vitae?

::: {.float-left}
<figure class="m-0">
<img src="PeFoXDy.png"
style="  object-fit: cover; object-position: center;  height: 250px;  width: 250px; margin-right: 15px"
data-zgotmplz="" alt="vitae logo" />
<p>The process of maintaining a CV can be tedious. It’s a task I often
forget about - that is until someone requests it and I find that my
latest is woefully out of date. To make matters worse, these
professional updates often need repeating across variety of sites (such
as ORCID and LinkedIn).</p>
<p>Having seen several CVs put together into an R Markdown document
(including my own, featuring a few quick and dirty hacks to make it
work), the need for an R package was obvious. With many attendees of the
<a href="https://ozunconf18.ropensci.org/">2018 rOpenSci OzUnconf</a>
having converted their CV to use R Markdown, the conference was the
perfect space to develop and formalise the ideas that many of us have
worked on independently in the past. Progress on the <code>vitae</code>
package progressed much faster than expected, in fact it took less time
to produce a functional prototype than it did to tidy the data for the
<a href="https://github.com/ropenscilabs/ozbabynames/">ozbabynames</a>
package! The <code>vitae</code> project was primarily worked on by
myself (<a
href="https://twitter.com/mitchoharawild">@mitchoharawild</a>) and Rob
Hyndman (<a href="https://twitter.com/robjhyndman">@robjhyndman</a>),
with ideas/discussion from <a
href="https://github.com/ropensci/ozunconf18/issues/24">many other
participants</a>.</p>
</figure>
:::

The `vitae` package leverages the dynamic nature of R Markdown to
quickly produce and update CV entries from a variety of data sources.
With use of the included templates, examples and helper functions, it
should be possible to produce a reasonable looking and data-driven CV in
less than an hour.

Based on the twitter community's response to the package announcement,
CV maintenance is just as unenjoyable for others as it is for me!
Hopefully this package makes it a little bit easier.

> Introducing the
> [\#rstats](https://twitter.com/hashtag/rstats?src=hash&ref_src=twsrc%5Etfw)
> vitae package, developed by myself and
> [@robjhyndman](https://twitter.com/robjhyndman?ref_src=twsrc%5Etfw) at
> [\#ozunconf18](https://twitter.com/hashtag/ozunconf18?src=hash&ref_src=twsrc%5Etfw)
> 📦🥳. The package provides Résumé/CV templates for use with R
> Markdown, and functions to add entries using data (great for
> integration with other packages!)  
> 🔗<https://t.co/yeDiLsTGeV>
> [pic.twitter.com/ndR9fmUknk](https://t.co/ndR9fmUknk)
>
> --- Mitchell O\'Hara-Wild (@mitchoharawild) [November 23,
> 2018](https://twitter.com/mitchoharawild/status/1065851259888914432?ref_src=twsrc%5Etfw)

### Keeping it simple

When developing an R package, it is easy to focus on features that are
specific to your needs. Without concern for the interface, adding an
abundance of specific features can make the package less useful overall.
The `vitae` package is an excellent example of simpler is better, and
less is more. `vitae` helps users to create a CV populated with data
from ORCID, Google Scholar, local spreadsheets, online databases, CRAN,
and endless others. However the `vitae` package does not directly
provide functionality for any of these features, instead it relies on a
common data format (a data-like object, such as a `data.frame` or
`tibble`).

This allows `vitae` to integrate seamlessly with other R packages to
pull in data for the CV.

- Want to get publications from ORCID? Try the
  [rorcid](https://github.com/ropensci/rorcid) package!
- How about Google Scholar? Heard of
  [scholar](https://github.com/jkeirstead/scholar)?
- Have a few CRAN packages? Include them with
  [pkgsearch](https://github.com/metacran/pkgsearch/).
- Employment history from LinkedIn? Well, I can't find a working package
  for that yet. Someone reading this, please get on that!

Another example of simplicity being best is the interface used to add CV
entries. Initially, we hastily started work on a function that produced
entries for education. We created an `education` function, with some
context specific arguments such as `degree`, `institution` and `awards`.
However when it came to adding functions for professional experiences
and related fields, we found that the resulting output was essentially
the same. These CV entries could be simplified into a more generic
`detailed_entries` function, that accepts more general arguments of
`what`, `when`, `with`, `where` and `why`. The usage of these functions
is now separated from a specific purpose, giving flexibility to use
these functions for any CV section. Similar can be said for entries
relating to awards and achievements, where the `brief_entries` function
can be used to include less detailed sections.

As an added bonus, simpler design decisions makes the package easier to
learn, and easier to develop!

### vitae for R

The `vitae` package is now available on CRAN, making it easy to install
with:

``` {tabindex="0"}
install.packages("vitae")
```

In version `0.1.0`, the `vitae` package provides four commonly used
LaTeX CV templates that have been modified for use with R Markdown. With
the `vitae` package installed, CV templates can be accessed from the
RStudio R Markdown template selector:

![RStudio template selector](Pib5DDC.png)

Like other R Markdown documents, the file is split into two sections:
the YAML header, and the main body.

``` {tabindex="0"}
---name: Mitchell O'Hara-Wilddate: "`r format(Sys.time(), '%B, %Y')`"qualifications: BCom(Hons), BScaddress: Melbourne, Australiaprofilepic: pic.jpgemail: mail@mitchelloharawild.comwww: mitchelloharawild.comgithub: mitchelloharawildlinkedin: mitchelloharawildtwitter: mitchoharawildheadcolor: 414141output: vitae::awesomecv---```rknitr::opts_chunk$set(echo = FALSE, warning = FALSE, message = FALSE)library(vitae)```# Professional SummaryThis is a good opportunity to introduce yourself professionally and summarisewhy your skills are well suited to the job you are applying for!
```

The YAML header contains general entries that are common across many
templates, such as your name, address and social media profiles. You can
also see that the output is set to `vitae::awesomecv`, which indicates
that this CV uses the [Awesome
CV](https://github.com/posquit0/Awesome-CV) template.

The main body of the document contains standard R Markdown code, which
is being used to set some document options, load the `vitae` package,
and add a professional summary to the CV.

Let's add to the main body with some education history. These details
are available on [ORCID](https://orcid.org) with my ID of
[0000-0001-6729-7695](https://orcid.org/0000-0001-6729-7695), which can
be dynamically accessed using the
[rorcid](https://github.com/ropensci/rorcid) package.

``` {tabindex="0"}
library(vitae)edu <- do.call("rbind",  rorcid::orcid_educations("0000-0001-6729-7695")$`0000-0001-6729-7695`$`affiliation-group`$summaries)edu %>%  detailed_entries(    what = `education-summary.role-title`,    when = glue::glue("{`education-summary.start-date.year.value`} - {`education-summary.end-date.year.value`}"),    with = `education-summary.organization.name`,    where = `education-summary.organization.address.city`  )
```

The CV entries functions from `vitae` using a similar syntax to
`dplyr::mutate`, where data manipulation can occur within the
`detailed_entries` function. This is used above to combine the starting
and ending year of my educations using the
[glue](https://github.com/tidyverse/glue) package. Also note that I have
not specified anything for `why` here. Any of the arguments can be
excluded, which will result in the corresponding CV field being left
empty.

Knitting the document will generate the CV with up to date data directly
from ORCID.

![Resulting CV output](Roj4jTZ.png)

To learn more about how `vitae` can be used to automate your CV this
year, the [*Introduction to vitae*
vignette](https://pkg.mitchelloharawild.com/vitae/articles/vitae.html)
is a great place to begin.

### Contributing to vitae

Résumé/CV templates are abundantly available in many varieties of themes
and layouts. The `vitae` package provides a few of the more popular
templates that are suitable for most resumes. The included templates are
far from comprehensive - your favourite template may not be included, or
perhaps you have created your own template.

The `vitae` package has been developed in a way that makes extending it
to support new templates simple! If you use a template that you'd like
to convert for usage with `vitae`, the package includes a vignette for
[*Creating vignette
templates*](https://pkg.mitchelloharawild.com/vitae/articles/extending.html).

You can then make your converted template available for anyone to use
via a pull request to the project's GitHub repository:
<https://github.com/ropenscilabs/vitae>


Why vitae?   The vitae package leverages the dynamic nature of R Markdown to quickly produce and update CV entries from a variety of data sources. With use of the included templates, examples and helper functions, it should be possible to produce a reasonable looking and data-driven CV in less than an hour.  Based on the twitter community’s response to the package announcement, CV maintenance is just as unenjoyable for others as it is for me!

Messaggi di Rogue Scholar

vitae: Dynamic CVs with R Markdown