From 4e7bf73735a39d79495ebba1fb2ca0a2b315af22 Mon Sep 17 00:00:00 2001
From: Grayson White <graysonwhite13@gmail.com>
Date: Thu, 18 Jul 2024 13:20:52 -0400
Subject: [PATCH] add JOSS paper template

---
 .github/workflows/draft-pdf.yml | 23 +++++++++
 paper/paper.bib                 | 85 +++++++++++++++++++++++++++++++++
 paper/paper.md                  | 36 ++++++++++++++
 3 files changed, 144 insertions(+)
 create mode 100644 .github/workflows/draft-pdf.yml
 create mode 100644 paper/paper.bib
 create mode 100644 paper/paper.md

diff --git a/.github/workflows/draft-pdf.yml b/.github/workflows/draft-pdf.yml
new file mode 100644
index 0000000..51a805e
--- /dev/null
+++ b/.github/workflows/draft-pdf.yml
@@ -0,0 +1,23 @@
+on: [push]
+
+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@v1
+        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
\ No newline at end of file
diff --git a/paper/paper.bib b/paper/paper.bib
new file mode 100644
index 0000000..4bd96a9
--- /dev/null
+++ b/paper/paper.bib
@@ -0,0 +1,85 @@
+  @article{wickham2010,
+  author = {Hadley Wickham},
+  title = {A Layered Grammar of Graphics},
+  journal = {Journal of Computational and Graphical Statistics},
+  volume = {19},
+  number = {1},
+  pages = {3-28},
+  year = {2010},
+  publisher = {Taylor & Francis},
+  doi = {10.1198/jcgs.2009.07098},
+  URL = {https://doi.org/10.1198/jcgs.2009.07098},
+  eprint = {https://doi.org/10.1198/jcgs.2009.07098}
+  }
+
+  @Book{ggplot2,
+    author = {Hadley Wickham},
+    title = {ggplot2: Elegant Graphics for Data Analysis},
+    publisher = {Springer-Verlag New York},
+    year = {2016},
+    isbn = {978-3-319-24277-4},
+    url = {https://ggplot2.tidyverse.org},
+  }
+    @Manual{broom,
+    title = {broom: Convert Statistical Objects into Tidy Tibbles},
+    author = {David Robinson and Alex Hayes and Simon Couch},
+    year = {2023},
+    note = {R package version 1.0.5},
+    url = {https://CRAN.R-project.org/package=broom},
+  }
+  
+    @Manual{broom.mixed,
+    title = {broom.mixed: Tidying Methods for Mixed Models},
+    author = {Ben Bolker and David Robinson},
+    year = {2022},
+    note = {R package version 0.2.9.4},
+    url = {https://CRAN.R-project.org/package=broom.mixed},
+  }
+  
+  @Article{tidyverse,
+    title = {Welcome to the {tidyverse}},
+    author = {Hadley Wickham and Mara Averick and Jennifer Bryan and Winston Chang and Lucy D'Agostino McGowan and Romain François and Garrett Grolemund and Alex Hayes and Lionel Henry and Jim Hester and Max Kuhn and Thomas Lin Pedersen and Evan Miller and Stephan Milton Bache and Kirill Müller and Jeroen Ooms and David Robinson and Dana Paige Seidel and Vitalie Spinu and Kohske Takahashi and Davis Vaughan and Claus Wilke and Kara Woo and Hiroaki Yutani},
+    year = {2019},
+    journal = {Journal of Open Source Software},
+    volume = {4},
+    number = {43},
+    pages = {1686},
+    doi = {10.21105/joss.01686},
+  }
+  
+  @misc{mcconville2023,
+  author        = {Kelly McConville},
+  title         = {STAT 100: Introduction to Statistics and Data Science},
+  year          = {2023},
+  publisher={Harvard University Department of Statistics},
+  url={https://mcconvil.github.io/stat100f23/},
+  note={Week 13, Wednesday}
+}
+
+  @Manual{R,
+    title = {R: A Language and Environment for Statistical Computing},
+    author = {{R Core Team}},
+    organization = {R Foundation for Statistical Computing},
+    address = {Vienna, Austria},
+    year = {2023},
+    url = {https://www.R-project.org/},
+  }
+  
+   @Manual{lindia,
+    title = {lindia: Automated Linear Regression Diagnostic},
+    author = {Yeuk Yu Lee and Samuel Ventura},
+    year = {2023},
+    note = {R package version 0.10},
+    url = {https://CRAN.R-project.org/package=lindia},
+  }
+  
+    @Article{lme4,
+    title = {Fitting Linear Mixed-Effects Models Using {lme4}},
+    author = {Douglas Bates and Martin M{\"a}chler and Ben Bolker and Steve Walker},
+    journal = {Journal of Statistical Software},
+    year = {2015},
+    volume = {67},
+    number = {1},
+    pages = {1--48},
+    doi = {10.18637/jss.v067.i01},
+  }
diff --git a/paper/paper.md b/paper/paper.md
new file mode 100644
index 0000000..d8607d4
--- /dev/null
+++ b/paper/paper.md
@@ -0,0 +1,36 @@
+---
+title: 'saeczi: A title'
+tags:
+  - R
+  - small area estimation
+  - zero-inflated models
+authors:
+  - name: Josh K. Yamamoto
+    orcid: XXXX-XXXX-XXXX-XXXX
+    affiliation: 1
+affiliations:
+ - name: Redcastle Resources, Inc.
+   index: 1
+date: 18 July 2024
+bibliography: paper.bib
+citation_author: Yamamoto et al.
+year: 2024
+---
+
+# Summary
+
+some text
+
+# Statement of Need
+
+some more text
+
+# Usage and Features
+
+some descriptive text
+
+# Comparison to Other Packages
+
+what else does similar things? 
+
+# References