forked from AuthorCarpentry/DTSTUDENT2018
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Base_2013_day2_in.Rmd
280 lines (167 loc) · 13.8 KB
/
Base_2013_day2_in.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
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
---
title: "Data Management Plan for the Study 'Do Reputable Open Access Journals Require Open Data Sharing'?"
author: "YourName, YourInstitution"
date: "`r format(Sys.Date(), '%A, %B %d, %Y')`"
output:
html_document:
code_folding: hide # hide code but shows a button that makes it appear
css: custom.css # code in the folder, for the coats to be smaller
toc: TRUE
toc_float: true # table of contents as a side bar
toc_depth: 2 # code highlight
theme: readable
highlight: kate #?
number_sections: yes
bibliography:
- oajournals.bib
- packages.bib
#csl: apa # citation style of preference (numbered, for example). you will need to download a citation style file from a repository and add it to your rmd project directory.
---
*****
```{r setup, include=FALSE, echo = FALSE}
# Load packages used in this exercise
library(tidyverse)
library(rmarkdown)
library(DT)
```
```{r global_options, include=FALSE}
# Set global options for chunk options
knitr::opts_chunk$set(echo=TRUE, warning=FALSE, message=FALSE, cache=FALSE)
```
```{r add_dataset}
# Add the dataset of DOAJ Seal journals
doaj_seal <- read_csv("data/DOAJ_Seal.csv")
```
# Administrative Data
## ID
Not Applicable
## Funder
This research is being submitted for funding to the [J. Bohannon Foundation](http://www.johnbohannon.org/).
## Grant Reference Number
Not Applicable (Proposal in preparation)
## Project Name
**Do Reputable Open Access Journals Require Open Data Sharing?**
## Project Description
This study analyzes the submission requirements of the most reputable open access journals to determine the prevalence and characteristics of data sharing policies. This question is an important one for 21st century authors and readers because open data sharing is seen as a key component of open and more trusted scientific record.
According to the *Research Data Alliance* (RDA) Data Policy Standardisation and Implementation group https://www.rd-alliance.org/groups/data-policy-standardisation-and-implementation:
"the prevalence of research data policies from institutions and research funders is increasing, so publishers and editors are paying more attention to standardisation and the wider adoption of data sharing policies."
This study investigates whether the most reputable Open Access journals have data sharing polices and the characteristics of those policies. These policies require authors, in some fashion, to openly disseminate the data and software underlying their published articles.
Our investigation builds on the recent work of @Castro_2017 who assessed the prevalence and characteristics of data sharing policies from randomly-selected, English-language, open access journals. Their findings reveal that only a small minority of these journals have data sharing policies. These findings -- which are consistent with those of other studies [see for example, @Vasilevsky_2017 -- may be skewed because of the authors' rules of inclusion and exclusion (FN: in particular, the choice to include open access journals merely because of their use of the Open Journal Systems (OJS) hosting platform; the choice to exclude non_English language journals).
In this study, we will include only the most reputable open access journals in our assessment of journal sharing policies, regardless of language. We will analyze all journals that have attained the Seal of Approval from the Directory of Open Access Journals, DOAJ http://doaj.org (shown below). We will apply the same coding framework devised by @Castro_2017 to the DOAJ Seal journals. We contend that a more rigorously screened population of open access journals, regardless of language, will yield a more accurate and reproducible set of findings than those published from @Castro_2017
||> Insert  <||
DOAJ Seal journals are considered the most reputable because they:
> "achieve a high level of openness, adhere to Best Practice and high publishing standards.The Seal is awarded to a journal that fulfills a set of criteria related to accessibility, openness, discoverability, reuse and author rights. It acts as a signal to readers and authors that the journal has generous use and reuse terms, author rights and adheres to the highest level of 'openness'. " (FN: DOAJ selection for Seal Approval is explained in the FAQ at https://doaj.org/faq#seal)
Moreover, the DOAJ Seal journals do include over 200 non-English language journals that merit analysis in this study. Excluding these from the analysis represents cultural bias that undermines reliable research. The following plot of DOAJ Seal Journals by Country indicates the problem.
```{r plot_country, echo= FALSE, fig.width=10,fig.height=11}
doaj <- read_csv(file = "data/DOAJ_Seal.csv")
ggplot(data=doaj, aes(doaj$PubCountry, fill=doaj$PubCountry)) +
stat_count() +
labs(x="Country", y="Count") +
theme(axis.text.x = element_text(angle = 45, vjust = 1, hjust=1))
```
Finally, our research group has determined that following is true when it comes to reputable open access journals.
||>
This code chunck add the LaTeX equations in the file equations-child.Rmd :)
```{r equations, child = "equations-child.Rmd"}
```
<||
## Researcher Information
YourName, Principal Investigator, YourInstitution
##Researcher ID
ORCID: [0000-0001-8424-9396](orcid.org/0000-0001-8424-9396)
##Date of First Version
Two months ago
##Date of Last Update
Today's date
##Related Policies
All original data, code, or reports produced as part of this project are owned by Your Institution per its institutional intellectual property policy.
The J. Bohannan Foundation adheres to the open access and data sharing policies of the Gates Foundation https://www.gatesfoundation.org/How-We-Work/General-Information/Open-Access-Policy
*****
#Data Collection
##Existing Data Being Reused
This study relies on the DOAJ Journal Metadata available as a csv file download from the DOAJ website https://doaj.org/faq#metadata. The csv file is updated every 30 minutes.
This data will be read into RStudio, using the tidyverse package (need to cite Tidyverse somehow) to filter it for those journals awarded the DOAJ Seal, and to remove unneeded columns containing the web addresses for journal policies around plagiarism, submission fees, and other urls not related to this study.
The filtered version of the data set will be exported as a new file named doaj_seal.csv for importing into analytical software.
A sample of the doaj_seal.csv data set is shown below. The complete data set is available in searchable and broweseable format in the [Annex](#annex-table) near the end of this document.
```{r}
knitr::kable(head(doaj_seal, 4), caption = 'A Table of the first 4 rows of the DOAJ Seal data.')
```
## Data being collected
The doaj_seal.csv data set currently includes over 1000 reputable open access journals that we will investigate in this study. The data set will be copied and enhanced with additional columns, resulting in the processed data set, doaj_seal_enhanced.csv. The following columns will be added to `doaj_seal.csv`, in conformance with the Coding Framework of @Castro_2017.
* 'Data Policy' (Boolean)
+ Yes
+ No
* 'Data Sharing Policy' (Factor)
a. No mention
a. Implied
a. Mentioned
+ Explicitly encouraged
+ Required, but not explicitly tied to editorial decisions
+ Required as a condition of publication
* 'Data Citation Policy' (Factor)
1. No mention
1. Implied
+ Explicitly encouraged
Investigators will examine the websites of each journal listed in the doaj_seal_enhanced.csv file to determine whether the data sharing policy is included in the Instructions to Authors. The Coding Framework published by @Castro_2017 will be applied.
### Data file formats and standards
All data retrieved for the DOAJ Seal of Approval are downloaded and stored in the open common separated value (csv) file format.
All data policies culled from the web sites of the DOAJ seal journals will be saved as .txt files. The data generated by applying @Castro_2017 Coding Framework will be stored in csv file format.
Analysis, visualization, and summarization of the study's findings will be performed in the open source software R and RStudio using the tidyverse package (cite tidyverse package). Reports produced from the study will be also be created in RStudio using the open source text format Rmarkdown (cite rmarkdown package) and output to HTML documents, slides, and MS Word documents for submission to funders or publishers (@Xie_2018, RMarkdown guide from CRC)
All files associated with the project will be maintained under the Git version control system and made openly available for download from the Principal Investigator's GitHub repository.
### Expected outputs of the project
|Output #|Digital Output|Type|Format,Duration,Size|Planned access|
|:------:|:-------|:-----------|:----------|:-------------|
|1|doaj_seal.csv|raw data set downloaded from DOAJ site| CSV file, plain text format, 2.7 MB | |
|2| doaj_seal_enhanced.csv | enhanced data set with new data | CSV file, plain text format, 2.7 MB | |
|3| Data set documentation | json metadata file | plain text file, .1 MB | |
|4| Data Processing steps | R scripts and comments | R Notebook file, 1 MB | |
|5| Data Visualizations | R scripts and documentation; Plots | R Notebook file, .png image files 4 MB | |
|6| Journal article | Rendered report | RMarkdown, 9 MB| |
```{r plot_license, echo= FALSE, fig.width=10,fig.height=11}
doaj <- read_csv(file = "data/DOAJ_Seal.csv")
ggplot(data=doaj, aes(doaj$JnlLicense, fill=doaj$JnlLicense)) + stat_count() + labs(x="License", y="Count", title = "DOAJ Seal by Country")
```
# Documentation and Metadata
The journal metadata contained in the project's data sets comes directly from the Directory of Open Access Journals.
The final outputs from the project will be documented in metadata files according to the DataCite DOI registration agency -- see the DataCite Metadata Schema 4.1 https://schema.datacite.org/ for specific details. By following this standard metadata format, other researchers (and computers) will be able to find, access, and reuse the outputs from this project by searching the DataCite metadatabase.
*****
# Ethics and Legal Compliance
No additional ethical or privacy issues arise in this study because both the DOAJ data, and the information about data policies for any published journal, are publicly posted online.
The data provided about journals awarded the Directory of Open Access Journals Seal of Approval is distributed under a CC BY-SA license. This license requires that reusers of the data share their derivative data set under the same license. Therefore, the output of this research will be disseminated under the CC BY-SA license. This license adheres to the *Principles and Guidelines of the Research Data Alliance Legal Interoperability Group*, which recommends the use of Creative Commons Attribution licenses to allow the broadest sharing of data while guaranteeing attribution to the data provider. (FN: https://www.rd-alliance.org/rda-codata-legal-interoperability-research-data-principles-and-implementation-guidelines-now
*****
# Storage and Backup
During the active phase of the project data will be stored on and backed up to the Research Data Storage Facility (RDSF) at My Institution. This facility represents 2 million pounds of digital resilient storage, with ongoing capital investment. The RDSF is overseen by a steering group of senior research and support staff, which includes the PVC Research. Backup procedures are robust (overnight backup, copies held remotely on tape) and secured access is in place
*****
# Selection and long-term preservation
||> To be completed by the participants! <||
****
# Data Sharing
The data and metadata will be made openly accessible under a CC-BY SA license in the CERN-maintained open access repository Zenodo https://zenodo.org/, an open dependable home for the long-tail of science, enabling researchers to share and preserve any research outputs in any size, any format and from any science. (FN: Zenodo policies are available online at http://about.zenodo.org/policies/
*****
# Responsibilities and Resources
The Principal Investigator is responsible for implementing the Data Management Plan and ensuring it is reviewed and revised as necessary. (S)he will be responsible for all data collection and recording; for data analysis and visualization; and for maintain all files under version control using git and GitHub.
The Data Management Specialist assigned to the project as an in-kind contribution from the My Institution Library will be responsible for creating the DataCite metadata documentation for all outputs and ensuring timely DOI registration of each final output. (S)he will also deposit all final outputs to the Zenodo repository and update metadata associated with the DOI as necessary.
# Annexes {-}
## Complete dataset `doaj_seal.csv` {#annex-table}
*This data table was compiled using the DT package by Xie (2018)*
||>
Turn this into a code chunk
```{r data-table}
doaj_seal %>%
datatable(rownames = FALSE,
colnames = c("Title", "Publisher", "Country", "Fees", "Waivers", "Identifiers", "Start Year", "Language(s)", "Review Process", "Plagiarism check", "Time to Press", "License", "Author owns Copyright", "DOAJ Seal"),
class = "cell-border stripe",
caption = "Journals with DOAJ Seal",
filter = list(position = "bottom"),
extensions = 'Buttons', options = list(dom = 'Bfrtip',
buttons = c('colvis', 'csv', 'pdf'))
)
```
<||
## Principal Investigator's BioSketch
This is auto-populated from your ORCID profile using the @R-rorcid package.
||> insert code from insert_orcid.R <||
# References {-}
Rmarkdown package citation of some kind, blahblahblah
Tidyverse package citation of some kind, blahblahblah
Xie (2018), DT Table package, CRAN, blahblahblah