-
Notifications
You must be signed in to change notification settings - Fork 0
/
README.Rmd
94 lines (66 loc) · 6.38 KB
/
README.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
---
output: github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
```
# Transparency Checklist
<!-- badges: start -->
<!-- badges: end -->
This is a public repository of the consensus-based transparency checklist developed by Aczel, et al. (2019).
### What is the Transparency Checklist?
The Transparency Checklist is a comprehensive checklist that researchers can use to improve and document the transparency of their research. This checklist was developed for social and behavioral scientists who conduct and report confirmatory research on primary data. Nevertheless, several of the checklist items may also be relevant for other approaches and disciplines.
### Where to find the Transparency Checklist?
The transparency checklist is available online at http://www.shinyapps.org/apps/TransparencyChecklist/. The short version of the checklist is available at http://www.shinyapps.org/apps/ShortTransparencyChecklist/.
### How to use it?
- The checklist refers to a single study of interest.
- Please respond to each checklist item. If necessary, you can provide an explanation at the end of each section.
- When the question refers to your manuscript, this includes all supplementary materials and appendices that are relevant to the study of interest.
- After all the questions have been answered, you can generate a transparency report for your study by pressing the button labeled GENERATE REPORT at the bottom of the page.
- Save your transparency report on your computer. Note that after you download your report, your responses on the checklist will not be saved by our webpage.
- Upload your transparency report to a public repository.
### What does this repository contain?
The repository contains code for the shiny applications in a form of an R package. You can install the development version of the package like so:
``` r
install.packages("remotes")
remotes::install_github("marton-balazs-kovacs/TransparencyChecklistGolem")
```
To run the shiny applications on your computer run the following command after the installation. Use the `short_checklist` argument to start either the short version of the transparency checklist (`short_checklist = TRUE`) or the full version (`short_checklist = FALSE`).
``` r
TransparencyChecklistGolem::run_app(short_checklist = FALSE)
```
The repository also contains the translations of the transparency checklist in the `inst/app/www/translations.json` document. If you would like to provide a new translation please contact ...
This code is based on the work of Simon Kucharsky [https://github.com/BalazsAczel/TransparencyChecklist](https://github.com/BalazsAczel/TransparencyChecklist).
### Feedback
Feedback and recommendations for an update of the checklist can be provided here: [https://forms.gle/raN7q1ucpov5sX316](https://forms.gle/raN7q1ucpov5sX316) or on this repository using the [issues page](https://github.com/BalazsAczel/TransparencyChecklist/issues).
### Citation
You can cite the Transparency Checklist as follows:
Aczel, B., Szaszi, B., Sarafoglou, A. Kekecs, Z., Kucharský, Š., Benjamin, D., ... & Wagenmakers, E.-J. (2019). A consensus-based transparency checklist. *Nature Human Behavior*, 1--3. [doi:10.1038/s41562-019-0772-6](https://doi.org/10.1038/s41562-019-0772-6)
BibTeX entry:
```
@article{Aczel2019,
doi = {10.1038/s41562-019-0772-6},
url = {https://doi.org/10.1038/s41562-019-0772-6},
year = {2019},
month = dec,
publisher = {Springer Science and Business Media {LLC}},
author = {Balazs Aczel and Barnabas Szaszi and Alexandra Sarafoglou and Zoltan Kekecs and {\v{S}}imon Kucharsk{\'{y}} and Daniel Benjamin and Christopher D. Chambers and Agneta Fisher and Andrew Gelman and Morton A. Gernsbacher and John P. Ioannidis and Eric Johnson and Kai Jonas and Stavroula Kousta and Scott O. Lilienfeld and D. Stephen Lindsay and Candice C. Morey and Marcus Monaf{\`{o}} and Benjamin R. Newell and Harold Pashler and David R. Shanks and Daniel J. Simons and Jelte M. Wicherts and Dolores Albarracin and Nicole D. Anderson and John Antonakis and Hal R. Arkes and Mitja D. Back and George C. Banks and Christopher Beevers and Andrew A. Bennett and Wiebke Bleidorn and Ty W. Boyer and Cristina Cacciari and Alice S. Carter and Joseph Cesario and Charles Clifton and Ron{\'{a}}n M. Conroy and Mike Cortese and Fiammetta Cosci and Nelson Cowan and Jarret Crawford and Eveline A. Crone and John Curtin and Randall Engle and Simon Farrell and Pasco Fearon and Mark Fichman and Willem Frankenhuis and Alexandra M. Freund and M. Gareth Gaskell and Roger Giner-Sorolla and Don P. Green and Robert L. Greene and Lisa L. Harlow and Fernando Hoces de la Guardia and Derek Isaacowitz and Janet Kolodner and Debra Lieberman and Gordon D. Logan and Wendy B. Mendes and Lea Moersdorf and Brendan Nyhan and Jeffrey Pollack and Christopher Sullivan and Simine Vazire and Eric-Jan Wagenmakers},
title = {A consensus-based transparency checklist},
journal = {Nature Human Behaviour}
}
```
### Translations
The translations for the Transparency Checklist are done by using a Google spreadsheet template. The translations are then combined and transformed to JSON format. The app reads the translations from this repository upon starting. To include new translations in the app or update existing translations do the following steps:
* Ask for access to the translation template on Google Drive from Balazs Aczel.
* Add a new translation or modify an existing one.
* Run the code in the `data-raw/translations.R` file to combine the translations and save them as JSON.
* If you are adding a new language add the name of the language as it is present in the title of the Google spreadsheet used for the translation and a short ISO language code to the `inst/app/www/language_codes.json` file.
* Run the code in the `data-raw/transform_json.R` file to transform the translations into an acceptable format for the i18n package that handles the translations. The `inst/app/www/i18n_locales.json` and the `inst/app/www/language_list.json` files should contain the changes you made at the end of the process.
* Stage, commit, then push the changes to the master branch and ask for a pull request.
* Once the pull request has been accepted the modifications to the translations will be made available to the users on all deployed versions of the application.