Skip to content

Commit

Permalink
Merge pull request #55 from MicheleNuijten/small-updates
Browse files Browse the repository at this point in the history
fix broken link to downloads badge & update version number
  • Loading branch information
MicheleNuijten authored Dec 9, 2022
2 parents 817c87a + 7d0e55b commit 8c21c68
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 13 deletions.
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Package: statcheck
Title: Extract Statistics from Articles and Recompute P-Values
Version: 1.4.0
Date: 2021-03-17
Date: 2022-12-09
Authors@R: c(
person("Michele B.", "Nuijten", email = "m.b.nuijten@uvt.nl",
role = c("aut", "cre")),
Expand Down
12 changes: 10 additions & 2 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,19 @@ knitr::opts_chunk$set(
)
```

```{r echo=FALSE, results="hide", message=FALSE}
library("badger")
```

# statcheck <a href='http://statcheck.io'><img src='man/figures/logo.jpg' align="right" height="100" /></a>

<!-- badges: start -->
[![CRAN status](https://www.r-pkg.org/badges/version/statcheck)](https://cran.r-project.org/package=statcheck)
[![CRAN_Downloads_Total](http://cranlogs.r-pkg.org/badges/grand-total/statcheck?color=brightgreen)](https://cran.r-project.org/package=statcheck)
```{r, echo = FALSE, results='asis'}
cat(
badge_cran_release("statcheck", "green"),
badge_cran_download("statcheck", "grand-total", "green")
)
```
<!-- badges: end -->

## What is statcheck?
Expand Down
20 changes: 10 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,13 @@

<!-- README.md is generated from README.Rmd. Please edit that file -->

<!-- after editing README.Rmd, run devtools::build_readme() -->

# statcheck <a href='http://statcheck.io'><img src='man/figures/logo.jpg' align="right" height="100" /></a>

<!-- badges: start -->

[![CRAN
status](https://www.r-pkg.org/badges/version/statcheck)](https://cran.r-project.org/package=statcheck)
[![CRAN\_Downloads\_Total](http://cranlogs.r-pkg.org/badges/grand-total/statcheck?color=brightgreen)](https://cran.r-project.org/package=statcheck)
[![](https://www.r-pkg.org/badges/version/statcheck?color=green)](https://cran.r-project.org/package=statcheck)
[![](http://cranlogs.r-pkg.org/badges/grand-total/statcheck?color=green)](https://cran.r-project.org/package=statcheck)
<!-- badges: end -->

## What is statcheck?
Expand All @@ -32,9 +30,9 @@ inconsistencies.
3. **Research**: `statcheck` can be used to automatically extract
statistical test results from articles that can then be analyzed.
You can for instance investigate whether you can predict statistical
inconsistencies (see e.g., [Nuijten et
al., 2017](https://www.collabra.org/article/10.1525/collabra.102/)),
or use it to analyze p-value distributions (see e.g., [Hartgerink et
inconsistencies (see e.g., [Nuijten et al.,
2017](https://www.collabra.org/article/10.1525/collabra.102/)), or
use it to analyze p-value distributions (see e.g., [Hartgerink et
al., 2016](https://peerj.com/articles/1935/)).

## How does statcheck work?
Expand All @@ -44,9 +42,11 @@ The algorithm behind `statcheck` consists of four basic steps:
1. **Convert** pdf and html articles to plain text files.
2. **Search** the text for instances of NHST results. Specifically,
`statcheck` can recognize *t*-tests, *F*-tests, correlations,
*z*-tests, \(\chi^2\) -tests, and Q-tests (from meta-analyses) if
they are reported completely (test statistic, degrees of freedom,
and *p*-value) and in APA style.
*z*-tests,
![\chi^2](https://latex.codecogs.com/png.image?%5Cdpi%7B110%7D&space;%5Cbg_white&space;%5Cchi%5E2 "\chi^2")
-tests, and Q-tests (from meta-analyses) if they are reported
completely (test statistic, degrees of freedom, and *p*-value) and
in APA style.
3. **Recompute** the *p*-value using the reported test statistic and
degrees of freedom.
4. **Compare** the reported and recomputed *p*-value. If the reported
Expand Down

0 comments on commit 8c21c68

Please sign in to comment.