From 20bb7b8e34e69c8328bbeb58c17d803873ed0a6d Mon Sep 17 00:00:00 2001 From: "G. Jay Kerns" Date: Fri, 25 Nov 2022 15:58:01 -0500 Subject: [PATCH] initial commit --- DESCRIPTION | 16 ++-- LICENSE | 4 +- LICENSE.md | 2 +- NEWS.md | 81 +------------------ R/.setup.R | 2 +- inst/rmarkdown/templates/thesis/template.yaml | 2 +- inst/rstudio/templates/project/skeleton.dcf | 4 +- 7 files changed, 15 insertions(+), 96 deletions(-) diff --git a/DESCRIPTION b/DESCRIPTION index c40c223a..ae80df47 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,15 +1,13 @@ -Package: thesisdown -Title: An updated R Markdown thesis template using the bookdown package -Version: 0.2.0.9000 +Package: penguindown +Title: An updated R Markdown YSU thesis template using the thesisdown package +Version: 0.1.0 Authors@R: c( - person("Chester", "Ismay", email = "chester.ismay@gmail.com", role = c("cre", "aut")), - person("Nick", "Solomon", email = "nick@nicksolomon.me", role = "aut"), - person("Shir", "Dekel", email = "shirdekel@yahoo.com.au", role = "ctb")) -Description: Using the bookdown package and LaTeX and Word thesis templates from - Reed College, this package aims to encourage reproducible research using + person("G. Jay", "Kerns", email = "gkerns@ysu.edu", role = c("cre", "aut")), +Description: Using the thesisdown package and LaTeX and Word thesis templates from + Youngstown State University, this package aims to encourage reproducible research using simple Markdown syntax while embedding all of the R code to produce plots and analyses as well. -Maintainer: Chester Ismay +Maintainer: G. Jay Kerns Depends: R (>= 3.2.0) Imports: diff --git a/LICENSE b/LICENSE index 78c20a7b..91b10f15 100644 --- a/LICENSE +++ b/LICENSE @@ -1,2 +1,2 @@ -YEAR: 2020 -COPYRIGHT HOLDER: Chester Ismay +YEAR: 2022 +COPYRIGHT HOLDER: G. Jay Kerns diff --git a/LICENSE.md b/LICENSE.md index e51e871f..31e2f568 100644 --- a/LICENSE.md +++ b/LICENSE.md @@ -1,6 +1,6 @@ # MIT License -Copyright (c) 2020 Chester Ismay +Copyright (c) 2022 G. Jay Kerns Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/NEWS.md b/NEWS.md index 62cb7f10..fbfe7747 100644 --- a/NEWS.md +++ b/NEWS.md @@ -1,83 +1,4 @@ -# thesisdown (development version - 0.2.0.9000) - -## Breaking changes to the template - -## Cosmetic changes to the template (non-breaking) - -- [@eugenesit](https://github.com/eugenesit) [discovered bug in output of -references](https://github.com/ismayc/thesisdown/issues/157) and it was -fixed with [this commit](https://github.com/ismayc/thesisdown/pull/159/commits/29ff90873e3a48cf3c8a5f80f945459c5f4389dc) - -## Updates to the package - -- Added thesisdown RStudio project template, which needs -{R.utils} to `copyDirectory()` -- Added GitHub Actions PR and issue lock - -# thesisdown 0.1.1 - -## Cosmetic changes to the template (non-breaking) - -- Finally figured out a long standing issue with csl-refs by using {rticles} code, fixing issue ([#133](https://github.com/ismayc/thesisdown/issues/133)) - -# thesisdown 0.2.0 - -## Breaking changes to the template - -- None - -## Cosmetic changes to the template (non-breaking) - -- [@shirdekel](https://github.com/shirdekel) added functionality to allow for other pandoc args to be -specified beyond setting the chapter as top level - -## Updates to the package - -- Added thesisdown RStudio project template, which needs -{R.utils} to `copyDirectory()` -- Added GitHub Actions PR and issue lock - -# thesisdown 0.1.1 - -## Cosmetic changes to the template (non-breaking) - -- Finally figured out a long standing issue with csl-refs by using {rticles} code, fixing issue ([#133](https://github.com/ismayc/thesisdown/issues/133)) - -# thesisdown 0.1.0 - -## Breaking changes to the template - -- Fixed issue ([#86](https://github.com/ismayc/thesisdown/issues/86)) with references not showing in Gitbook version in [#91](https://github.com/ismayc/thesisdown/pull/91) PR - - [Moved preliminary content files for the Gitbook to a `prelims` folder](https://github.com/ismayc/thesisdown/pull/91/commits/46dce4572fe027f51e1335cab4348d2492e61265). Note that this was needed since using the Knit button in RStudio with {thesisdown} does not appear to allow for the `rmd_files` argument to be used in building theses. - - [Fixed \headheight is too small error](https://github.com/ismayc/thesisdown/pull/91/commits/4374e7a81b9d16fa79eb2b9a483cf4cfcd71af6f) - - [Updated the YAML of `index.Rmd` to ensure references pass through in Gitbook](https://github.com/ismayc/thesisdown/pull/91/commits/42aecc61f662e19f32c0a7b3e1e2fc7cfa3dcd92) - -## Cosmetic changes to the template (non-breaking) - -- [Converted http to https throughout Rmd files](https://github.com/ismayc/thesisdown/commit/aa4bac89ab7cf91d7898d9b52d737b00e6b6f71a) -- [Reduced `flights.csv` included data](https://github.com/ismayc/thesisdown/commit/0a6bf0c5d6bdb75be4e09a58b588feeaff778af0) to prepare for sending to CRAN -- Fixed issue (#[116](https://github.com/ismayc/thesisdown/issues/116)) with toc depth not showing in table of contents beyond depth of 3 in [#117](https://github.com/ismayc/thesisdown/pull/117) PR -- Removed pandoc table from Chapter 3 as multiple reports (here's [one](https://github.com/ismayc/thesisdown/issues/125)) of it continuing to not build were reported in [#130](https://github.com/ismayc/thesisdown/pull/130) PR - -## Updates to the package - -- Fixed failure of template to build due to `pandoc` changes brought up in Issue [#122](https://github.com/ismayc/thesisdown/issues/122) ([#124](https://github.com/ismayc/thesisdown/pull/124)) -- Added support for customizing of `thesisdown::gitbook()` ([#84](https://github.com/ismayc/thesisdown/pull/84)) -- Added hex sticker ([1](https://github.com/ismayc/thesisdown/commit/ababba5437ee2fe0632c74d5428fed35b911c751) and [2](https://github.com/ismayc/thesisdown/commit/d556073c94ae5069d4373fc73811b3115905c56f)) -- [Created {pkgdown} site](https://github.com/ismayc/thesisdown/commit/7febd70b98ae6e8d104bf1080e066468d030b968) -- [Added MIT License](https://github.com/ismayc/thesisdown/pull/91/commits/7ba5cf1ea24876e248ae9e78d28a43212b6f759b) and other cosmetic tweaks to [#91](https://github.com/ismayc/thesisdown/pull/91) PR -- [Switched to using `Imports` instead of `Depends` for best practice](https://github.com/ismayc/thesisdown/commit/2a39610b8f3a97974d9220976edb1d14cd74d6e5#diff-35ba4a2677442e210c23a00a5601aba3R14) - - [Updated template Rmd files to reflect change to Imports](https://github.com/ismayc/thesisdown/commit/b5dd154e8c87cc9f971b185e667ea4a8b104ddcd) - - Added Chester Ismay as author and creator to DESCRIPTION - -# thesisdown 0.0.2 - -- Changed default filename (in directions) to be `index` instead of `skeleton` to match with gitbook requirements -- Added preliminary files `00--prelim.Rmd` and changed `abstract.Rmd` to `00-abstract.Rmd` to match -with renaming of files so that `index.Rmd` always comes last alphabetically -- Removed _book and _bookdown_files directories since they are stored at - -# thesisdown 0.0.1 +# penguindown 0.1.0 - Initial release - PDF version working diff --git a/R/.setup.R b/R/.setup.R index bf0e7e0f..b6de5e4d 100644 --- a/R/.setup.R +++ b/R/.setup.R @@ -5,6 +5,6 @@ invisible(lapply(suggest_pkgs, usethis::use_package, type = "Suggests")) usethis::use_pkgdown() usethis::use_readme_rmd() -usethis::use_mit_license(name = "Chester Ismay") +usethis::use_mit_license(name = "G. Jay Kerns") usethis::use_package("R.utils", type = "Imports") diff --git a/inst/rmarkdown/templates/thesis/template.yaml b/inst/rmarkdown/templates/thesis/template.yaml index f4a9e8e7..f38ee23d 100644 --- a/inst/rmarkdown/templates/thesis/template.yaml +++ b/inst/rmarkdown/templates/thesis/template.yaml @@ -1,4 +1,4 @@ name: Thesis description: > - Template for creating a Senior Thesis at Reed College using R Markdown based on the Reed College LaTeX and Word templates and the R bookdown package. + Template for creating a Master's Thesis at Youngstown State University using R Markdown based on the YSU LaTeX and Word templates and the R thesisdown package. diff --git a/inst/rstudio/templates/project/skeleton.dcf b/inst/rstudio/templates/project/skeleton.dcf index 266fa9d5..06f48313 100644 --- a/inst/rstudio/templates/project/skeleton.dcf +++ b/inst/rstudio/templates/project/skeleton.dcf @@ -1,4 +1,4 @@ -Title: Thesis Project using thesisdown -Binding: thesisdown_skeleton +Title: Thesis Project using penguindown +Binding: penguindown_skeleton OpenFiles: index.Rmd Icon: graduation_cap.png