Merge pull request #18 from tpronk/fix-documentation

Fix documentation

.Rbuildignore

@@ -4,3 +4,4 @@
 ^\.Rproj\.user$
 ^splithalfr.Rproj$
 LICENSE
+CITATION.cff

CITATION.cff

@@ -2,9 +2,9 @@ cff-version: 1.2.0
 title: "splithalfr: Estimates split-half reliabilities for scoring algorithms of cognitive tasks and questionnaires"
 message: "Please cite the software itself and the journal article from 'preferred-citation'."
 type: software
-url: "https://github.com/tpronk/splithalfr/"
-version: "2.2.0"
-date-released: "2021-09-29"
+doi: 10.5281/zenodo.7777894
+version: "2.2.2"
+date-released: "2023-09-14"
 authors:
   - given-names: Thomas
     family-names: Pronk

DESCRIPTION

@@ -1,7 +1,7 @@
 Package: splithalfr
 Title: Estimate Split-Half Reliabilities
-Version: 2.2.0
-Date: 2021-09-28
+Version: 2.2.2
+Date: 2023-09-14
 Author: Thomas Pronk [aut, cre]
 Authors@R: person("Thomas", "Pronk", email = "[email protected]", role = c("aut", "cre"))
 Description: Estimates split-half reliabilities for scoring algorithms of cognitive tasks and questionnaires. The 'splithalfr' supports researcher-provided scoring algorithms, with six vignettes illustrating how on included datasets. The package provides four splitting methods (first-second, odd-even, permutated, Monte Carlo), the option to stratify splits by task design, a number of reliability coefficients, and the option to sub-sample data.
@@ -20,7 +20,7 @@ Imports:
     psych (>= 1.8.12),
     bcaboot (>= 0.2.1),
     rlang (>= 0.4.0)
-RoxygenNote: 7.1.1
+RoxygenNote: 7.2.3
 VignetteBuilder: knitr
 URL: https://github.com/tpronk/splithalfr
 BugReports: https://github.com/tpronk/splithalfr/issues

R/data.R

@@ -6,7 +6,7 @@
 #' Upon an incorrect response, the current trial was repeated. The response to each trial was logged.
 #' This particular dataset is from a Ethnicity-Valence IAT, which was administered (and described in detail) in 
 #' \doi{10.1016/j.tate.2019.102887}{Abacioglu and colleagues (2019)}. 
-#' This dataset was graciously provided by \href{https://www.uva.nl/en/profile/h/a/f.hanna/f.hanna.html}{Fadie Hanna} and \href{https://www.researchgate.net/profile/Marjolein-Zee-2}{Marjolein Zee}.
+#' This dataset was graciously provided by Fadie Hanna and Marjolein Zee.
 #' 
 #' Overview of columns:
 #' \itemize{
@@ -46,7 +46,7 @@
 #' were non-alcoholic beverages, selected from the Amsterdam Beverage Picture Set
 #' \doi{10.1111/acer.12853}{(Pronk, Deursen, Beraha, Larsen, & Wiers, 2015)}.
 #' The dataset contains one row per trial.
-#' This dataset was graciously provided by \href{https://www.researchgate.net/profile/Marilisa-Boffo}{Marilisa Boffo}.
+#' This dataset was graciously provided by Marilisa Boffo.
 #' 
 #' Overview of columns:
 #' \itemize{
@@ -75,7 +75,7 @@
 #' while avoid responses were given via the arrow up key. Upon a response, the stimulus zoomed in or
 #' out, until it disappeared from the screen. The first response to a stimulus was logged. 
 #' The dataset contains one row per trial.
-#' This dataset was graciously provided by \href{https://www.researchgate.net/profile/Eva-Schmitz}{Eva Schmitz}.
+#' This dataset was graciously provided by Eva Schmitz.
 #' 
 #' Overview of columns:
 #' \itemize{
@@ -120,7 +120,7 @@
 #' The Go/No Go is a task in which participants respond to one set of stimuli, but withhold a response
 #' to another set of stimuli. This particular dataset is from the first session of a study that is 
 #' described in detail in \doi{10.1016/j.tate.2019.102887}{Hedge, Powell, and Sumner (2018)}. 
-#' It was graciously provided by \href{https://www.researchgate.net/profile/Craig-Hedge}{Craig Hedge} and can
+#' It was graciously provided by Craig Hedge and can
 #' be obtained from \href{https://osf.io/cwzds}{https://osf.io/cwzds}.
 #' 
 #' Overview of columns:
@@ -142,7 +142,7 @@
 #' On 25% of trials the participant heard a tone that indicated that the participant should withhold their response.
 #' This particular dataset is from the first session of a study that is 
 #' described in detail in \doi{10.1016/j.tate.2019.102887}{Hedge, Powell, and Sumner (2018)}. 
-#' It was graciously provided by \href{https://www.researchgate.net/profile/Craig-Hedge}{Craig Hedge} and can
+#' It was graciously provided by Craig Hedge and can
 #' be obtained from \href{https://osf.io/cwzds}{https://osf.io/cwzds}.
 #' 
 #' Overview of columns:

R/splithalfr.R

@@ -36,18 +36,18 @@
 #' 
 #' @section Acknowledgments:
 #' I would like to thank 
-#' \href{https://www.researchgate.net/profile/Craig-Hedge}{Craig Hedge},
-#' \href{https://www.researchgate.net/profile/Eva-Schmitz}{Eva Schmitz},
-#' \href{https://www.uva.nl/en/profile/h/a/f.hanna/f.hanna.html}{Fadie Hanna},
+#' Craig Hedge,
+#' Eva Schmitz,
+#' Fadie Hanna,
 #' \href{https://scholar.google.com/citations?user=ugPnkjEAAAAJ&hl=en}{Helle Larsen},
-#' \href{https://www.researchgate.net/profile/Marilisa-Boffo}{Marilisa Boffo}, and
-#' \href{https://www.researchgate.net/profile/Marjolein-Zee-2}{Marjolein Zee}
+#' Marilisa Boffo, and
+#' Marjolein Zee
 #' for making datasets available for inclusion in the splithalfr.
 #' Additionally, I would like to thank 
-#' \href{https://www.researchgate.net/profile/Craig-Hedge}{Craig Hedge} and 
+#' Craig Hedge and 
 #' \href{https://www.swinburne.edu.au/research/our-research/access-our-research/find-a-researcher-or-supervisor/researcher-profile/?id=bwilliams}{Benedict Williams}
 #' for sharing R-scripts with scoring algorithms that were adapted for splithalfr vignettes. 
-#' Finally, I would like to thank \href{https://www.researchgate.net/profile/Mae-Nuijs}{Mae Nuys} and Maren Sera for spotting bugs in earlier versions of this package.
+#' Finally, I would like to thank Mae Nuijs and Sera-Maren Wiechert for spotting bugs in earlier versions of this package.
 #' 
 #' @importFrom dplyr %>% group_by group_modify summarize bind_rows
 #' @importFrom stats cor sd var cov reshape
@@ -59,4 +59,4 @@
 #' @importFrom rlang .data
 #' @docType package
 #' @name splithalfr
-NULL
+"_PACKAGE"

README.md

@@ -8,9 +8,9 @@ Please cite the software and the compendium paper.
 
 Pronk, T., Molenaar, D., Wiers, R. W., & Murre, J. M. J. (2021). Methods to split cognitive task data for estimating split-half reliability: A comprehensive review and systematic assessment. *Psychonomic Bulletin & Review*. https://doi.org/10.3758/s13423-021-01948-3
 
-### Software citation (for version 2.0.0)
+### Software citation (for version 2.2.2)
 
-Pronk, T. (2021). *splithalfr: Estimates split-half reliabilities for scoring algorithms of cognitive tasks and questionnaires* (Version 2.2.0) [Computer software]. https://github.com/tpronk/splithalfr/
+Pronk, T. (2023). *splithalfr: Estimates split-half reliabilities for scoring algorithms of cognitive tasks and questionnaires* (Version 2.2.2) [Computer software]. https://doi.org/10.5281/zenodo.7777894
 
 ## Getting started
 We've got six short vignettes to help you get started. You can open a vignette bij running the corresponding code snippets `vignette(...)` in the R console.
@@ -36,4 +36,4 @@ Part of the splithalfr algorithm has been validated via a set of simulations tha
 These R packages offer bootstrapped split-half reliabilities for specific scoring algorithms and are available via CRAN at the time of this writing:  [multicon](https://cran.r-project.org/package=multicon), [psych](https://cran.r-project.org/package=psych), and [splithalf](https://cran.r-project.org/package=splithalf).
 
 ## Acknowledgments:
-I would like to thank [Craig Hedge](https://www.researchgate.net/profile/Craig-Hedge), [Eva Schmitz](https://www.researchgate.net/profile/Eva-Schmitz), [Fadie Hanna](https://www.uva.nl/en/profile/h/a/f.hanna/f.hanna.html), [Helle Larsen](https://scholar.google.com/citations?user=ugPnkjEAAAAJ&hl=en), [Marilisa Boffo](https://www.researchgate.net/profile/Marilisa-Boffo), and [Marjolein Zee](https://www.researchgate.net/profile/Marjolein-Zee-2), for making datasets available for inclusion in the splithalfr. Additionally, I would like to thank [Craig Hedge](https://www.researchgate.net/profile/Craig-Hedge) and [Benedict Williams](https://www.swinburne.edu.au/research/our-research/access-our-research/find-a-researcher-or-supervisor/researcher-profile/?id=bwilliams) for sharing R-scripts with scoring algorithms that were adapted for splithalfr vignettes. Finally, I would like to thank [Mae Nuys](https://www.researchgate.net/profile/Mae-Nuijs) and [Sera-Maren Wiechert](https://www.linkedin.com/in/sera-maren-wiechert-b37625122/) for spotting bugs in earlier versions of this package.
+I would like to thank Craig Hedge, Eva Schmitz, Fadie Hanna, [Helle Larsen](https://scholar.google.com/citations?user=ugPnkjEAAAAJ&hl=en), Marilisa Boffo, and Marjolein Zee, for making datasets available for inclusion in the splithalfr. Additionally, I would like to thank Craig Hedge and [Benedict Williams](https://www.swinburne.edu.au/research/our-research/access-our-research/find-a-researcher-or-supervisor/researcher-profile/?id=bwilliams) for sharing R-scripts with scoring algorithms that were adapted for splithalfr vignettes. Finally, I would like to thank Mae Nuijs and Sera-Maren Wiechert for spotting bugs in earlier versions of this package.

inst/CITATION

@@ -1,16 +1,25 @@
-citHeader("To cite the splithalfr, please use:")
-citEntry(
-  entry = "Article",
-  author = c(
-    person("Pronk", "Thomas"),
-    person("Molenaar", "Dylan"),
-    person("Wiers", "Reinout"),
-    person("Murre", "Jaap")
+c(
+  bibentry(
+    bibtype = "Article",
+    author = c(
+      person("Thomas", "Pronk"),
+      person("Dylan", "Molenaar"),
+      person("Reinout", "Wiers"),
+      person("Jaap", "Murre")
+    ),
+    title = "Methods to split cognitive task data for estimating split-half reliability: A comprehensive review and systematic assessment",
+    journal = "Psychonomic Bulletin & Review",
+    doi = "10.3758/s13423-021-01948-3",
+    pages = "1-11",
+    year = "2021"
   ),
-  title = "Methods to split cognitive task data for estimating split-half reliability: A comprehensive review and systematic assessment",
-  journal = "Psychonomic Bulletin & Review",
-  doi = "10.3758/s13423-021-01948-3",
-  pages = "1-11",
-  year = "2021",
-  textVersion  = "Pronk, T., Molenaar, D., Wiers, R. W., & Murre, J. (2021). Methods to split cognitive task data for estimating split-half reliability: A comprehensive review and systematic assessment. Psychonomic Bulletin & Review, 1-11. https://doi.org/10.3758/s13423-021-01948-3",
+  bibentry(
+    bibtype = "Manual",
+    author = c(
+      person("Thomas", "Pronk")
+    ),
+    title = "splithalfr: Estimates split-half reliabilities for scoring algorithms of cognitive tasks and questionnaires (Version 2.2.2) [Computer software]",
+    doi = "10.5281/zenodo.7777894",
+    year = "2021"
+  )
 )

vignettes/sst_ssrti.Rmd

@@ -20,7 +20,7 @@ knitr::opts_chunk$set(
 library(splithalfr)
 ```
 
-This vignette describes the Stop-Signal Reaction Time integration method (SSRTi); a scoring method introduced by [Logan (1981)](http://www.psy.vanderbilt.edu/faculty/logan/Logan(1981).pdf). The scoring function was adapted from an R-script that was graciously made available by [Craig Hedge](https://www.researchgate.net/profile/Craig-Hedge) and used in [Hedge, Powell, and Sumner (2018)](https://doi.org/10.1016/j.tate.2019.102887).
+This vignette describes the Stop-Signal Reaction Time integration method (SSRTi); a scoring method introduced by [Logan (1981)](http://www.psy.vanderbilt.edu/faculty/logan/Logan(1981).pdf). The scoring function was adapted from an R-script that was graciously made available by Craig Hedge and used in [Hedge, Powell, and Sumner (2018)](https://doi.org/10.1016/j.tate.2019.102887).
 
 <br />