JOSS publication (#1885)

* add boilerplate

* say more about need and benefits of lintr

* update PDF as well

* fix merge issues [skip ci]

* add a few examples

* try width [skip ci]

* discuss specific tags

* only show examples that lint

* add section on best practices

* retain TeX file as well [skip ci]

* address Jim's comment [skip ci]

* Update paper/paper.Rmd

Co-authored-by: Michael Chirico <[email protected]>

* mention tidyverse style guide up front

* we only need md document

* Update draft-pdf.yml

* preserve YAML; add initial list of authors

* initial acknowledgments

* change example for best practices

* also add example that doesn't lint

* Update paper/paper.Rmd [skip ci]

Co-authored-by: Michael Chirico <[email protected]>

* Update paper/paper.Rmd [skip ci]

Co-authored-by: Michael Chirico <[email protected]>

* Update paper/paper.Rmd [skip ci]

Co-authored-by: Michael Chirico <[email protected]>

* update ignore regex; update workflow

* add bib entry for style guide

* change a couple of examples

* add common mistakes section

* michael has an orcid somehow :)

* Apply Michael's suggestions from code review

Co-authored-by: Michael Chirico <[email protected]>

* reknit

* add chunk labels

* move customizability segment to later

* Just create a new section to highlight extensibility

* more on customization

* add citation to wiki page

* Update paper/paper.Rmd [skip ci]

Co-authored-by: Michael Chirico <[email protected]>

* Update paper/paper.Rmd [skip ci]

Co-authored-by: Michael Chirico <[email protected]>

* consistently use with-without lint pairing [skip ci]

* use latest, blazingly fast upload artifact action

* authors: Jim first, everyone else alphabetical

* Update paper.md

Co-authored-by: Jim Hester <[email protected]>

* update Rmd file for Jim's ORCID

---------

Co-authored-by: Michael Chirico <[email protected]>
Co-authored-by: Michael Chirico <[email protected]>
Co-authored-by: Jim Hester <[email protected]>

Author: 3 people

.Rbuildignore

@@ -29,3 +29,4 @@
 ^vignettes/[^-]+.gif$
 ^CRAN-SUBMISSION$
 ^CODE_OF_CONDUCT\.md$
+^paper$

.github/workflows/draft-pdf.yml

@@ -0,0 +1,30 @@
+# TODO: delete this file once the paper is published
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  paper:
+    runs-on: ubuntu-latest
+    name: Paper Draft
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Build draft PDF
+        uses: openjournals/openjournals-draft-action@master
+        with:
+          journal: joss
+          # This should be the path to the paper within your repo.
+          paper-path: paper/paper.md
+
+      - name: Upload
+        uses: actions/upload-artifact@v4
+        with:
+          name: paper
+          # This is the output path where Pandoc will write the compiled
+          # PDF. Note, this should be the same directory as the input
+          # paper.md
+          path: paper/paper.pdf