Skip to content

Commit

Permalink
Updates README, NEWS, and CITATION
Browse files Browse the repository at this point in the history
  • Loading branch information
crsh committed Oct 23, 2024
1 parent 51d7a47 commit 7591bf3
Show file tree
Hide file tree
Showing 5 changed files with 46 additions and 9 deletions.
5 changes: 5 additions & 0 deletions README.Rmd
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
---
title : "<img src='tools/images/papaja_hex.png' align='right' height='150' />papaja: Prepare APA Journal Articles<br />with R Markdown"
output: github_document
# github_document:
# toc: true
# toc_depth: 2
---

```{r include = FALSE}
Expand All @@ -12,6 +15,8 @@ if(!requireNamespace("depgraph", quietly = TRUE)) remotes::install_github("crsh/

[![CRAN/METACRAN](https://img.shields.io/cran/v/papaja?label=CRAN&logo=r)]( https://cran.r-project.org/package=papaja) [![Project Status: Active - The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active) ![GitHub last commit (main)](https://img.shields.io/github/last-commit/crsh/papaja/main?label=Last%20commit&logo=github) [![R-CMD-check](https://github.com/crsh/papaja/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/crsh/papaja/actions/workflows/R-CMD-check.yaml) [![codecov](https://codecov.io/gh/crsh/papaja/branch/master/graph/badge.svg)](https://app.codecov.io/gh/crsh/papaja) [![GitHub bug issues](https://img.shields.io/github/issues/crsh/papaja/bug?label=Bugs&logo=github)](https://github.com/crsh/papaja/issues?q=is%3Aopen+is%3Aissue+label%3Abug) [![StackOverflow questions](https://img.shields.io/stackexchange/stackoverflow/t/papaja?label=Questions&logo=stackoverflow)](https://stackoverflow.com/questions/tagged/papaja)

**Sections** [Example](#example) | [Installation](#installation) | [Usage](#usage) | [Getting help](#getting-help) | [Citation](#citation) | [papaja in the wild](#papaja-in-the-wild) | [Computational reproducibility](#computational-reproducibility) | [Contribute](#contribute) | [Related R packages](#related-r-packages) | [Package dependencies](#package-dependencies)

**papaja** is an [award-winning](https://improvingpsych.org/mission/awards/) R package that facilitates creating computationally reproducible, submission-ready manuscripts which conform to the American Psychological Association (APA) manuscript guidelines (6th Edition).
**papaja** provides

Expand Down
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,13 @@ issues](https://img.shields.io/github/issues/crsh/papaja/bug?label=Bugs&logo=git
[![StackOverflow
questions](https://img.shields.io/stackexchange/stackoverflow/t/papaja?label=Questions&logo=stackoverflow)](https://stackoverflow.com/questions/tagged/papaja)

**Sections** [Example](#example) \| [Installation](#installation) \|
[Usage](#usage) \| [Getting help](#getting-help) \|
[Citation](#citation) \| [papaja in the wild](#papaja-in-the-wild) \|
[Computational reproducibility](#computational-reproducibility) \|
[Contribute](#contribute) \| [Related R packages](#related-r-packages)
\| [Package dependencies](#package-dependencies)

**papaja** is an
[award-winning](https://improvingpsych.org/mission/awards/) R package
that facilitates creating computationally reproducible, submission-ready
Expand Down Expand Up @@ -308,6 +315,7 @@ your BibTeX file:
year = {2024},
note = {R package version 0.1.3},
url = {https://github.com/crsh/papaja},
doi = {10.32614/CRAN.package.papaja},
}
```

Expand Down
1 change: 1 addition & 0 deletions inst/CITATION
Original file line number Diff line number Diff line change
Expand Up @@ -21,4 +21,5 @@ bibentry(
, year = year
, note = note
, url = meta$URL
, doi = "10.32614/CRAN.package.papaja"
)
39 changes: 30 additions & 9 deletions inst/NEWS.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,40 @@
# Upcoming release
# papaja 0.1.3

### New functions

- For ANOVA methods, *MSE*s are again returned if requested by the user (reported by @Sashpta, [#562](https://github.com/crsh/papaja/issues/562)). The global default for reporting *MSE*s now depends on the [**effectsize**](https://CRAN.r-project.org/package=effectsize) package: If **effectsize** is installed, the default for reporting *MSE*s is `FALSE`, if **effectsize** is not installed, the default is `TRUE`.
- Added `apa_print()` support for analysis of deviance from the **car** package.
- Added new plotting function `apa_violinplot()` for violin plots.
- Accordingly, `apa_factorial_plot()` gained arguments `args_violins` and `args_density`.
- Accordingly, `apa_factorial_plot()` gained arguments `args_violins` and `args_density`.

### Existing functions

- `generate_author_yml()`
- Now preserves affiliation order for each author (see #569).
- `apa_print()` now supports output from `stats::binom.test()` (see [#576](https://github.com/crsh/papaja/issues/576)).
- Now preserves affiliation order for each author (see #569, @conig).
- `apa_print()`
- now returns an output object that is consistent with other output from `apa_print()`
- The table element does not have row names.
- Term names are now consistently constructed with `sanitize_terms()`.
- now supports output from `stats::binom.test()` (see [#576](https://github.com/crsh/papaja/issues/576)).
- now supports analysis of deviance from the **car** package.
- For ANOVA methods, *MSE*s are again returned if requested by the user (reported by @Sashpta, [#562](https://github.com/crsh/papaja/issues/562)). The global default for reporting *MSE*s now depends on the [**effectsize**](https://CRAN.r-project.org/package=effectsize) package: If **effectsize** is installed, the default for reporting *MSE*s is `FALSE`, if **effectsize** is not installed, the default is `TRUE`.
- `apa_*plot()` functions have gained a new argument `set_par`.
- `sanitize_terms()` now also replaces multiple consecutive underscores with a single underscore and removes leading underscores. This affects term names in output from `apa_print()`.
- `apa_print()` now returns an output object that is consistent with other output from `apa_print()`
- The table element does not have row names.
- Term names are now consistently constructed with `sanitize_terms()`.
- `cite_r()`
- gained the `lang` argument to specify the language of to-be-generated text.

### Misc

- Several improvements to the documentation

### Templates

- APA 6
- DOCX
- Fixed bugs in table and figure numbering
- New YAML front matter flag `doi_citations` to use DOI-based citations via the [`doi2cite`](https://github.com/korintje/pandoc-doi2cite/blob/main/doi2cite.lua) filter, see [**rmdfiltr** vignette](https://cran.r-project.org/web/packages/rmdfiltr/vignettes/doi2cite.html).
- Revision letter
- LaTeX error `LaTeX Error: Lonely \item--perhaps a missing list environment` is now fixed (reported by @cjvanlissa, [#587](https://github.com/crsh/papaja/issues/587); fixed by @jvcasillas, [#593](https://github.com/crsh/papaja/pull/593))
- Updated to latest version of CSL files


# papaja 0.1.2

Expand Down
2 changes: 2 additions & 0 deletions inst/WORDLIST
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ Anova
BFBayesFactor
BFBayesFactorList
BFBayesFactorTop
BCP
Bakeman
CMD
CSL
Expand Down Expand Up @@ -122,3 +123,4 @@ wsci
xtable
yaml
yml
rempsyc

0 comments on commit 7591bf3

Please sign in to comment.