https://github.com/mps9506/quartoyaac

Convenience R functions for adding and using the quarto-yaac template.
https://github.com/mps9506/quartoyaac

quarto quarto-template r

Last synced: about 1 month ago
JSON representation

Convenience R functions for adding and using the quarto-yaac template.

• Host: GitHub
• URL: https://github.com/mps9506/quartoyaac
• Owner: mps9506
• License: other
• Created: 2023-03-15T23:11:10.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2023-03-16T17:05:12.000Z (almost 2 years ago)
• Last Synced: 2024-06-11T18:24:37.422Z (6 months ago)
• Topics: quarto, quarto-template, r
• Language: R
• Homepage:
• Size: 12.7 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.Rmd
  • License: LICENSE

Awesome Lists containing this project

README

        
---

output: github_document

---

```{r, include = FALSE}

knitr::opts_chunk$set(

  collapse = TRUE,

  comment = "#>",

  fig.path = "man/figures/README-",

  out.width = "100%"

)

```

# quartoYAAC

[![lifecycle](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://www.tidyverse.org/lifecycle/#experimental)

[![R-CMD-check](https://github.com/mps9506/quartoYAAC/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/mps9506/quartoYAAC/actions/workflows/R-CMD-check.yaml)

quartoYAAC provides a convenience function for adding the [quarto-yaac](https://github.com/mps9506/quarto-yaac) template to your current R project. It also includes several functions that converts data frames to the .tex used by the underlying document document class.

## Installation

You can install the development version of quartoYAAC from [GitHub](https://github.com/) with:

``` r

# install.packages("remotes")

remotes::install_github("mps9506/quartoYAAC")

```

## Use

### Template

To add the template to your current R project:

```r

library(quartoYAAC)

use_quarto_yaac(file_name = "My_CV")

```

If you are in an interactive session, the .qmd file will open. 

### Headings

Specify section headings using H1 (`#`) and adding the `.sectiontitle` class. To include a formatted fontawesome icon in the heading include the `.faIcon` class as the second class (replacing "Icon" with the desired icon name). For example:

```

# Experience {.sectiontitle .faSuitcase}

```

See [the fontawesome5 Latex package documentation](https://mirrors.mit.edu/CTAN/fonts/fontawesome5/doc/fontawesome5.pdf) for a full list of FontAwesome icons and names that can be used in this template.

### Formatting Functions

Some functions are included to make formatting sections easier.

 - `print_skills_block()`: formatted skills section

 - `print_experience_block()`: formatted work experience section

 - `print_education_block()`: formatted education section

 - `print_project_block()`: formatted projects section

 - `print_referee_block()`: formatted referee section