apaquarto

https://github.com/wjschne/apaquarto
Admin
apaquarto is a Quarto extension that creates APA Style 7th Edition documents in .docx, .html, and...
Tokens:61,834
Snippets:643
Trust Score:9.6
License:CC0-1.0
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Minimal YAML metadata example

Source: https://github.com/wjschne/apaquarto/blob/main/README.md

A complete YAML front matter example for an apaquarto document, including title, author information, abstract, keywords, bibliography, and format specifications. This is a minimal starting point for a manuscript.

```yaml
---
title: "My Paper's Title: A Full Analysis of Everything"
shorttitle: "My Paper's Title"
author:
  - name: W. Joel Schneider
    corresponding: true
    orcid: 0000-0002-8393-5316
    email: schneider@temple.edu
    affiliations:
      - name: Temple University
        department: College of Education and Human Development
        address: 1301 Cecil B. Moore Ave.
        city: Philadelphia
        region: PA
        postal-code: 19122-6091
abstract: "This is my abstract."
keywords: [keyword1, keyword2]
author-note:
  disclosures:
    conflict of interest: The author has no conflict of interest to declare.
bibliography: mybibfile.bib 
documentmode: manscript
format:
  apaquarto-docx: default
  apaquarto-html: default
  apaquarto-pdf: default
  apaquarto-typst: default
---
```

--------------------------------

### Install the quarto R package

Source: https://github.com/wjschne/apaquarto/blob/main/README.md

Run this in the R console to install the quarto package (version 1.4 or higher) if it is not already installed. This is a prerequisite for using the R console method to create a new article.

```r
# latest release version 
install.packages("quarto")
```

--------------------------------

### Install quarto R package

Source: https://github.com/wjschne/apaquarto/blob/main/docs/installation.html

Installs the quarto R package, which provides functions to interact with Quarto. Needed for the R console installation methods. Requires version 1.4 or higher.

```r
install.packages("quarto")
```

--------------------------------

### Install required R packages for graphics devices

Source: https://github.com/wjschne/apaquarto/blob/main/docs/writing.html

Installs the svglite and ragg packages, which are needed for documents with R chunks because apaquarto names a graphics device for every format.

```r
install.packages(c("svglite", "ragg"))
```

--------------------------------

### Create a new article using the quarto R package

Source: https://github.com/wjschne/apaquarto/blob/main/README.md

After installing the quarto package, set your working directory to the desired folder and run this command in the R console. It will prompt you to confirm that you trust the author before proceeding.

```r
quarto::quarto_use_template("wjschne/apaquarto")
```

--------------------------------

### Mask and masked-citations example

Source: https://github.com/wjschne/apaquarto/blob/main/docs/options.html

Enables masking and lists citation keys to be masked when mask is true.

```yaml
mask: true
masked-citations:
  - mypublication2020
  - mypublication2024
```

--------------------------------

### Author front matter example

Source: https://github.com/wjschne/apaquarto/blob/main/docs/options.html

Shows the YAML front matter for specifying authors, affiliations, roles, and corresponding author details. The corresponding author must include an email and mailing address.

```yaml
author:
  - name: W. Joel Schneider
    corresponding: true
    orcid: 0000-0002-8393-5316
    email: schneider@temple.edu
    affiliations:
      - name: Temple University
        department: College of Education and Human Development
        address: 1301 Cecil B. Moore Ave.
        city: Philadelphia
        region: PA
        postal-code: 19122-6091
    role:
      - writing
      - conceptualization
  - name: Fulano Zutano Mengano
    affiliations: Universidad de Dondequiera
    orcid: 0000-0000-0000-0001
    role:
      - formal analysis
      - visualization
      - editing
  - name: Thomas Richard Harris
    affiliations: 
      - name: Generic State University
        department: Department of Scholarly Studies
    orcid: 0000-0000-0000-0002
    role:
      - editing
      - funding acquisition
  - name: Wut C. Whosis
    affiliations: Whatchama College
    orcid: 0000-0000-0000-0003
    role:
      - software
      - methodology
      - editing
```

--------------------------------

### Markdown example with Abstract and Introduction headings

Source: https://github.com/wjschne/apaquarto/blob/main/docs/options.html

Shows a typical document structure where the abstract is a section and the introduction heading is used to mark the end of the abstract. apaquarto removes a level-one heading with text 'Introduction' from the output.

```markdown
# Abstract

The abstract goes here.

# Introduction

The body of the paper starts here, and the heading above it does not
appear in the output.
```

--------------------------------

### Check Quarto version in terminal

Source: https://github.com/wjschne/apaquarto/blob/main/docs/installation.html

Run this command in a terminal to check the installed Quarto version. apaquarto requires Quarto 1.9 or greater; if the version is older, install Quarto separately and restart RStudio.

```bash
quarto --version
```

--------------------------------

### Install apaquarto with apa7 package

Source: https://github.com/wjschne/apaquarto/blob/main/docs/installation.html

Installs apaquarto using the dedicated function from the apa7 package. This is an alternative to the quarto package functions. The no_prompt = TRUE argument suppresses the trust prompt.

```r
apa7::install_apaquarto(no_prompt = TRUE)
```

--------------------------------

### Navigate to folder with cd command

Source: https://github.com/wjschne/apaquarto/blob/main/docs/installation.html

Changes the terminal's current directory to the specified folder. Use this to navigate to the folder where you want to install apaquarto.

```bash
cd "C:/Users/myname/Documents/MyProject/"
```

--------------------------------

### Citation with prefix

Source: https://github.com/wjschne/apaquarto/blob/main/docs/writing.html

Place prefixes (with or without a comma) before the reference. The example renders as (e.g., Cameron & Trivedi, 2013).

```markdown
[e.g., @CameronTrivedi2013]
```

--------------------------------

### Run and update apaquarto tests with make and Rscript

Source: https://github.com/wjschne/apaquarto/blob/main/tests/README.md

Run the full test suite, update snapshots, filter to a single format, or skip snapshot comparison. Requires Quarto, R, and the packages in DESCRIPTION; PDF fixtures need a LaTeX installation.

```bash
make test                 # render everything and check
make test-update          # accept the current .tex and .typ as snapshots
Rscript tests/run-tests.R --filter typst
Rscript tests/run-tests.R --no-snapshots
```

--------------------------------

### Configure apanote filter in YAML

Source: https://github.com/wjschne/apaquarto/blob/main/docs/writing.html

Example YAML configuration for using the apanote filter in a standard Quarto document. The quarto filter must be listed before apanote to ensure proper execution order.

```yaml
---
title: "An ordinary document"
format: html
filters:
  - quarto
  - apanote
---
```

--------------------------------

### Minimal apaquarto YAML metadata

Source: https://github.com/wjschne/apaquarto/blob/main/docs/installation.html

Minimal YAML metadata example for an apaquarto document, including title, author information, abstract, keywords, bibliography, and output formats.

```yaml
---
title: "My Paper's Title: A Full Analysis of Everything"
shorttitle: "My Paper's Title"
author:
  - name: W. Joel Schneider
    corresponding: true
    orcid: 0000-0002-8393-5316
    email: schneider@temple.edu
    affiliations:
      - name: Temple University
        department: College of Education and Human Development
        address: 1301 Cecil B. Moore Ave.
        city: Philadelphia
        region: PA
        postal-code: 19122-6091
abstract: "This is my abstract."
keywords: [keyword1, keyword2]
author-note:
  disclosures:
    conflict of interest: The author has no conflict of interest to declare.
bibliography: mybibfile.bib     
format:
  apaquarto-docx: default
  apaquarto-html: default
  apaquarto-pdf: default
  apaquarto-typst: default
---
```

--------------------------------

### Create an appendix with #apx- identifier

Source: https://github.com/wjschne/apaquarto/blob/main/docs/writing.html

Start an appendix with a level-1 header in title case, and include an identifier with the `#apx-` prefix. Cite the appendix in text using the identifier, e.g., `See @apx-myappendix`.

```markdown
# Reliability Analysis of the Individual Differences Scale {#apx-myappendix}

The Individual Differences Scale's reliability coefficients can be seen in @tbl-idsrxx.
```

--------------------------------

### Create a new article using the terminal

Source: https://github.com/wjschne/apaquarto/blob/main/README.md

Navigate to the folder where you want to create the file and run this command in the terminal. It will prompt you to confirm trust and then ask for a new folder name for the extension.

```bash
quarto use template wjschne/apaquarto
```

--------------------------------

### YAML key-value pair syntax

Source: https://github.com/wjschne/apaquarto/blob/main/docs/options.html

Shows the basic YAML syntax for setting a metadata key to a value.

```yaml
key: value
```

--------------------------------

### Bullet List Markdown

Source: https://github.com/wjschne/apaquarto/blob/main/docs/writing.html

Markdown syntax for a bullet list. Each line starts with an asterisk and a space. Rendered as an unordered list.

```markdown
* Item A
* Item B
* Item C
```

--------------------------------

### Create a Quarto Document

Source: https://github.com/wjschne/apaquarto/blob/main/docs/writing.html

An annotated example of a short Quarto document. The YAML between pairs of three hyphens contains metadata such as title and author. Markdown text below the YAML becomes the document content. The code chunk with {r} runs R code, here defining x <- 5.

```markdown
---
title: My Title
author: W. Joel Schneider
---

This is plain text.
A pair of asterisks makes *italics*.
Two asterisks will **bold** text.

```{r}
x <- 5
```
```

--------------------------------

### Parenthetical citation with @

Source: https://github.com/wjschne/apaquarto/blob/main/docs/writing.html

Use square brackets with the reference label prefixed by @ for a parenthetical citation. The example renders as (Cameron & Trivedi, 2013).

```markdown
A sentence that needs a citation [@CameronTrivedi2013].
```

--------------------------------

### Create new apaquarto template via R console

Source: https://github.com/wjschne/apaquarto/blob/main/docs/installation.html

Creates a new Quarto project with the apaquarto template from the R console. Requires the quarto package (version 1.4 or higher). Set the working directory first. The no_prompt = TRUE argument suppresses the trust prompt.

```r
quarto::quarto_use_template("wjschne/apaquarto", no_prompt = TRUE)
```

--------------------------------

### Set working directory in R

Source: https://github.com/wjschne/apaquarto/blob/main/docs/installation.html

Sets the working directory to the specified path in R. Use this before installing the apaquarto extension or creating a project.

```r
setwd("C:/Users/myname/Documents/MyProject/")
```

--------------------------------

### Configure DOCX lists

Source: https://github.com/wjschne/apaquarto/blob/main/docs/options.html

Enable lists of contents, figures, and tables for DOCX output using the apaquarto-docx format configuration.

```yaml
format:
  apaquarto-docx:
    list-of-contents: true
    list-of-figures: true
    list-of-tables: true
```

--------------------------------

### Override figure title prefix in YAML

Source: https://github.com/wjschne/apaquarto/blob/main/docs/options.html

Example of overriding the default 'Figure' term for figure captions to 'Plot' using the `crossref-fig-title` key.

```yaml
language: 
  crossref-fig-title: "Plot"
```

--------------------------------

### Set Spanish language options in YAML

Source: https://github.com/wjschne/apaquarto/blob/main/docs/options.html

Example of setting `lang` to `es` and providing Spanish translations for apaquarto-specific fields under the `language` key.

```yaml
lang: es
language: 
  citation-last-author-separator: "y"
  citation-masked-author: "Cita Enmascarada"
  citation-masked-title: "Título Enmascarado"
  citation-masked-date: "n.f."
  title-block-author-note: "Nota de Autores"
  title-block-correspondence-note: "La correspondencia relativa a este artículo debe dirigirse a"
  title-block-role-introduction: "Los roles de autor se clasificaron utilizando la taxonomía de roles de colaborador (CRediT; https://credit.niso.org/) de la siguiente manera:"
  references-meta-analysis: "Las referencias marcadas con un asterisco indican estudios incluidos en el metanálisis."
  title-impact-statement: "Declaración de Impacto"
  title-word-count: "Recuento de Palabras"
```

--------------------------------

### Numeric List Markdown

Source: https://github.com/wjschne/apaquarto/blob/main/docs/writing.html

Markdown syntax for a numeric list. Each line starts with a number followed by a period and a space. Rendered as an ordered list.

```markdown
1. Item A
2. Item B
3. Item C
```

--------------------------------

### Multiple bibliography files

Source: https://github.com/wjschne/apaquarto/blob/main/docs/options.html

Sets the bibliography to an array of .bib files.

```yaml
bibliography: [mybibliography.bib, myotherbibliography.bib]
```
Tokens:
Raw