-
Notifications
You must be signed in to change notification settings - Fork 0
/
index.html
1027 lines (761 loc) · 36.9 KB
/
index.html
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
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!DOCTYPE html>
<html lang="" xml:lang="">
<head>
<title>Accelerating Computational Reproducibility with the Social Science Reproduction Platform</title>
<meta charset="utf-8" />
<meta name="author" content="Fernando Hoces de la Guardia, BITSS" />
<script src="libs/header-attrs/header-attrs.js"></script>
<link href="libs/remark-css/default.css" rel="stylesheet" />
<link href="libs/remark-css/metropolis.css" rel="stylesheet" />
<link href="libs/remark-css/metropolis-fonts.css" rel="stylesheet" />
</head>
<body>
<textarea id="source">
class: center, middle, inverse, title-slide
# Accelerating Computational Reproducibility with the Social Science Reproduction Platform
## PUC, Chile
### Fernando Hoces de la Guardia, BITSS
### October 2021 | <a href="https://bitss.github.io/acre-slides-puc/">slides</a>
---
background-image: url("Images/BITSSlogo.png"), url(Images/cega.png)
background-size: contain, 200px
background-position: 50% 100% , 100% 10%
count:true
#[BITSS](https://bitss.org)
<style>
.center2 {
margin: 0;
position: absolute;
top: 50%;
left: 50%;
-ms-transform: translate(-50%, -50%);
transform: translate(-50%, -50%);
}
pre.sourceCode {
max-height: 200px;
overflow-y: auto;
}
/*
.remark-slide-number {
position: inherit;
}
.remark-slide-number .progress-bar-container {
position: absolute;
bottom: 0;
height: 4px;
display: block;
left: 0;
right: 0;
}
.remark-slide-number .progress-bar {
height: 100%;
background-color: blue;
}
*/
</style>
<style type="text/css">
# CSS for including pauses in printed PDF output (see bottom of lecture)
@media print {
.has-continuation {
display: block !important;
}
}
</style>
.pull-left[
The Berkeley Initiative for Transparency in the Social Sciences works to improve </br>the credibility of science by </br>
advancing transparency, </br> reproducibility, rigor, and </br> ethics in research and policy analysis.
.font130[**Core ACRe**]
Aleks Bogdanoski
Albert Chae
Fernando Hoces de la Guardia
Katie Hoeberling
Edward Miguel
Lars Vilhuber
]
.pull-right[ .right[
We are part of the Center for Effective Global Action ([CEGA](https://cega.berkeley.edu/)).
</br></br></br></br></br></br></br>
.font130[[**Many Others**](https://bitss.github.io/ACRE/contributions.html#list-of-contributors-guidelines-content-and-source-code)]
CEGA staff
Undergrad and Graduate RAs
Catalysts
Outside Collaborators
(Researchers, Programmers)
]]
---
name: motivation
# Motivation 1: "Reproducibility Crisis"
</br></br>
.font170[
| Replication in Social Sciences<br>(same method, different sample) | Reproduction in Economics<br>(same data and methods) |
|------------------------------------------------------------------- |------------------------------------------------------ |
| OSC ([2015](https://docs.google.com/document/d/1mm_4HZnEz_2Bh8XuiS2tpqCH08MFPyqUhi1baKPqR8Y/edit#heading=h.7vqf2cziid7z)): 30%-60% | Chang & Li ([2015](https://www.nowpublishers.com/article/Details/CFR-0053)): 43% |
| Camerer et. al. ([2016](https://science.sciencemag.org/content/351/6280/1433)): ~60% | Gertler et. al. ([2017](https://www.nature.com/articles/d41586-018-02108-9)): 14% |
| Nosek & Camerer et. al. ([2018](https://www.nature.com/articles/s41562-018-0399-z)): ~60% | Kingi et. al. ([2018](https://hautahi.com/static/docs/Replication_aejae.pdf)): 43% |
| Klein et. al. ([2018](https://journals.sagepub.com/doi/10.1177/2515245918810225)): 50% | Wood et. al. ([2018](https://journals.plos.org/plosone/article?id=10.1371/journal.pone.0209416#abstract0)): 25% |
]
---
count:false
# .font90[M2: More Inclusive Concept Scholarly Output]
.pull-left[
.font120[
<blockquote>
Clarebout Principle:
</br></br>
“An article about computational science in a scientific publication is not the scholarship itself, it’s merely scholarship advertisement. The actual scholarship is the complete software development environment and the complete set of instructions which generated the figures.”
</br></br>
.right[ <cite> Buckheit and D.L. Donoho (1995, [2009](https://academiccommons.columbia.edu/doi/10.7916/D8QZ2MDS/download))</cite> ]
</blockquote>
]
]
---
background-image: url("Images/iceberg.jpg")
background-size: 50%
background-position: 100% 50%
# .font90[M2: More Inclusive Concept Scholarly Output]
.pull-left[
.font120[
<blockquote>
Clarebout Principle:
</br></br>
“An <b>article</b> about computational science in a scientific publication is not the scholarship itself, <b>it’s merely scholarship advertisement</b>. The actual <b>scholarship is the complete software development environment and the complete set of instructions which generated the figures</b>.”
</br></br>
.right[ <cite> Buckheit and D.L. Donoho (1995, [2009](https://academiccommons.columbia.edu/doi/10.7916/D8QZ2MDS/download))</cite> ]
</blockquote>
]
]
---
# .font90[M2: More Inclusive Concept Scholarly Output]
.font130[
Potential benefits of following the Clarebout Principle
Well discussed potential positive effects on:
- Pedagogy
- Incremental generation of knowledge
]
--
.font130[
Under discussed:
- Possible positive effect on diversity, equity and inclusion: no connections or language skills ("appropriate politeness") required to obtain materials
]
???
An under discussed benefit of this principle is that increases access to knowledge for students who are outside of elite schools (no connections or "appropriate politeness" required to obtain materials).
---
# M3: Prevent Loss of Knowledge
Every semester, graduate students around **the world** take an Empirical/Applied [`...`] Economics course. A typical assignment consists of reproducing the results of a paper and, possibly, testing the robustness of its results.
--
| Stage | New Knowledge |
|:-----------------: |:------------------------------------------------------------: |
| </br></br> | |
| </br></br> | |
| </br></br> | |
| </br></br> | </br> |
---
count:false
# M3: Prevent Loss of Knowledge
Every semester, graduate students around **the world** take an Empirical/Applied [`...`] Economics course. A typical assignment consists of reproducing the results of a paper and, possibly, testing the robustness of its results.
| Stage | New Knowledge |
|:-----------------: |:------------------------------------------------------------: |
| Scope </br> (select and verify) | Data and code exist? |
| </br></br> | |
| </br></br> | |
| </br></br> | </br> |
---
count:false
# M3: Prevent Loss of Knowledge
Every semester, graduate students around **the world** take an Empirical/Applied [`...`] Economics course. A typical assignment consists of reproducing the results of a paper and, possibly, testing the robustness of its results.
| Stage | New Knowledge |
|:-----------------: |:------------------------------------------------------------: |
| Scope </br> (select and verify) | Data and code exist? |
| Assess | Degree of reproducibility for <br>specific part of the paper |
| </br></br> | |
| </br></br> | </br> |
---
count:false
# M3: Prevent Loss of Knowledge
Every semester, graduate students around **the world** take an Empirical/Applied [`...`] Economics course. A typical assignment consists of reproducing the results of a paper and, possibly, testing the robustness of its results.
| Stage | New Knowledge |
|:-----------------: |:------------------------------------------------------------: |
| Scope </br> (select and verify) | Data and code exist? |
| Assess | Degree of reproducibility for <br>specific part of the paper |
| Improve | E.g. fixed paths, libraries,<br>added missing files, etc. |
| </br></br> | </br> |
---
count:false
# M3: Prevent Loss of Knowledge
Every semester, graduate students around **the world** take an Empirical/Applied [`...`] Economics course. A typical assignment consists of reproducing the results of a paper and, possibly, testing the robustness of its results.
| Stage | New Knowledge |
|:-----------------: |:------------------------------------------------------------: |
| Scope </br> (select and verify) | Data and code exist? |
| Assess | Degree of reproducibility for <br>specific part of the paper |
| Improve | E.g. fixed paths, libraries,<br>added missing files, etc. |
| Test robustness | Results are robust to additional <br>specifications |
---
# M3: Prevent Loss of Knowledge
</br>
.font120[
- In each of the previous steps there was valuable new knowledge
- This knowledge is not usually disseminated
- End of semester report, or presentation that is not published.
- Language across courses is not standard (reproduction? replication?)
- Current attempts to record this are closer to a full paper format (see [Replication Wiki](https://replication.uni-goettingen.de/))
- As a result there is a large amount of missed knowledge.
- Each new semester, new students repeat similar excesses and have to reinvent the wheel.
- Lost opportunity for building on top of previous exercises.
- Lost opportunity for aggregating the new knowledge.
]
---
name: guidelines
# Context for ACRE
- American Economics Association (AEA) creates first data policy in 2006.
- Must publish some data (waivers available)
--
- AEA updates [policy in 2019](https://www.aeaweb.org/journals/policies/data-code/).
- Must post all data and code. Publication is conditional on verifying reproducibility (if confidential: must document extensively)
- A new requirement is to post all cleaning code, even for data that is not public
--
- We should expect high levels of computational reproducibility after 2019 (AEA).
--
- We should not demand 100% reproducibility before, but we could identify the gaps and try to improve some.
---
# .font90[**A**ccelerating **C**omputational **Re**producibility: Framework]
## Beyond Binary Judgments
Reproductions can easily gravitate towards adversarial exchanges.
- Early career researchers (ECR) have incentives to emphasize unsuccessful reproductions
- Original authors have a more senior position and can use it to deter in-depth reproductions from ECRs.
- The media also focuses on eye-catching headlines
--
### Our approach:
We do not want to say
> "Paper X is (ir)reproducible"
--
We do want to say
> "Result Y in paper X has a high/low level of reproducibility according to several reproduction attempts. Moreover, improvements have been made to the original reproduction package, increasing its reproducibility to a higher level"
---
count:false
# .font90[**A**ccelerating **C**omputational **Re**producibility: Framework]
## Beyond Binary Judgments
Reproductions can easily gravitate towards adversarial exchanges.
- Early career researchers (ECR) have incentives to emphasize unsuccessful reproductions
- Original authors have a more senior position and can use it to deter in-depth reproductions from ECRs.
- The media also focuses on eye-catching headlines
### Our approach:
We do not want to say
> "Paper X is (ir)reproducible"
We do want to say
> "Result Y in paper X has a high/low **level** of reproducibility according to **several** reproduction attempts. Moreover, **improvements** have been made to the original reproduction package, **increasing** its reproducibility to a higher level"
---
count: true
background-image: url(Images/paper-claims.svg)
background-size: 610px
background-position: 75% 0%
# ACRe Framework
.pull-left[
.font100[
Each **reproduction attempt** is centered <br>
around scientific **claims** (following [SCORE](https://replicats.research.unimelb.edu.au)).
One paper can contain several claims.
Each claim may be supported by various </br>
**display items**: tables, figures & inline results.
A reproduction attempt is at the claim level, <br>
and reproducers must record their <br>
**specifications** of interest.
Key challenge: **standardization** of concepts <br>
and formats.
]
DI: Display Item
S: Specificaiton
]
.pull-right[
]
---
background-image: url(Images/home_page.png)
background-size: contain
count:true
.center[
# Demo: [socialsciencereproduction.org]()
]
---
background-image: url(Images/stages.svg)
background-size: contain
# Stages
---
background-image: url(Images/select.svg), url(Images/select_paper.png)
background-size: 400px, 700px
background-position: 95% 100%, 0% 10%
count:false
# Select a paper
---
background-image: url(Images/select.svg), url(Images/select_example.png), url(Images/select_paper.png)
background-size: 400px, 600px, 700px
background-position: 95% 100%, 100% 0%, 0% 10%
count:true
# Select a paper
---
background-image: url(Images/scope.svg), url(Images/scope_paper.png)
background-size: 400px, 700px
background-position: 95% 100%, 0% 10%
count:false
# Scope
---
background-image: url(Images/scope.svg), url(Images/scope_paper2.png) , url(Images/scope_paper.png)
background-size: 400px, 500px, 700px
background-position: 95% 100%, 90% 0%, 0% 10%
count:false
# Scope
---
background-image: url(Images/scope.svg), url(Images/scope_example.png), url(Images/scope_paper2.png) , url(Images/scope_paper.png)
background-size: 400px, 600px, 500px, 700px
background-position: 95% 100%, 100% 75%, 90% 0%, 0% 10%
count:true
# Scope
---
background-image: url(Images/assess.svg), url(Images/assess_paper1.png)
background-size: 400px, 120px
background-position: 95% 100%, 0% 10%
count:false
# Assess
---
background-image: url(Images/assess.svg), url(Images/assess_paper2.png)
background-size: 400px, 120px
background-position: 95% 100%, 0% 10%
count:false
# Assess
---
background-image: url(Images/assess.svg), url(Images/assess_example1.png), url(Images/assess_paper2.png)
background-size: 400px, 500px, 120px
background-position: 95% 100%, 15% 50%, 0% 10%
count:false
# Assess
---
background-image: url(Images/assess_example2.png), url(Images/assess.svg), url(Images/assess_example1.png) , url(Images/assess_paper2.png)
background-size: 600px, 400px, 500px, 120px
background-position: 100% 80%,95% 100%, 15% 50%, 0% 10%
count:true
# Assess
---
background-image: url(Images/improve.svg)
background-size: 700px
background-position: 50% 20%
# Improvements
</br></br></br></br></br></br></br></br>
## Three types of improvements:
.font130[
1. Improvements at the paper level
2. Improvements at the display-item level
3. Specific future improvements
]
---
background-image: url(Images/improve.svg)
background-size: 300px
background-position: 0% 100%
# Improvements: Paper-level
.font140[
- Use version control software (Git/Github).
- Improve documentation: comments, indentations, object names, etc.
- Re-organize the reproduction package into a set of folders and sub-folders that follow [standardized best practices](https://www.projecttier.org/tier-protocol/specifications/#overview-of-the-documentation), and add a master script that executes all the code in order, with no further modifications. [See AEA's reproduction template](https://github.com/AEADataEditor/replication-template).
- Literate programming environment (e.g., Jupyter notebooks, RMarkdown)
- Re-write code using a differenet statistical software (ideally open source, like R, Python, or Julia).
- Set up a computing capsule (e.g., [Binder](https://mybinder.org/) and [Code Ocean](https://codeocean.com/)).
]
---
background-image: url(Images/improve.svg)
background-size: 300px
background-position: 0% 100%
# Improvements: Display item-level
</br>
.font120[
- Adding missing raw data: files or meta-data
- Example: "Add raw temperature and relative humidity data"
- Adding missing analytic data files
- Example: "Copy the row files from Data folder into new `Analysis\trade cost\Input`"
- Adding missing analysis or cleaning code
- Example: "Replaced broken Wald bootstrap code with updated code/command"
- Debugging code
- Example: "was counting each group 4 times in round 1, so fixed that"
]
---
background-image: url(Images/improve.svg)
background-size: 300px
background-position: 0% 100%
# Improvements: future possible
We ask reproducer to leave concise and actionable tasks for other reproducers in the future.
Example 1:
>"Revise the .aml and .bat code scripts to reflect reorganized structure"
Example 2:
> "Provide data and codes generating the other two figures in the paper, which are not given in the replication file."
Example 3:
> "Table 3 can be reproduced identically from the [...] analytic data files. I was not able to reproduce the analytic data files due to lack of access to ArcGIS software, but the code scripts and raw data files [...] are included in the reproduction package."
---
background-image: url(Images/robust.svg)
background-size: 700px
background-position: 50% 20%
# Robustness Checks
</br></br></br></br></br></br></br></br>
## Two main parts for robustness:
.font130[
1. Increase the number of robustness checks
2. Justify the appropriateness of a specific test
]
---
background-image: url(Images/robust.svg), url("Images/robustness checks.svg")
background-size: 300px, 500px
background-position: 0% 100%, 100% 60%
# Robustness
**Robustness checks:** any possible change in a computational choice, both in data analysis and data cleaning
--
.pull-left[
**Reasonable specifications** ([Simonsohn et. al., 2018](https://urisohn.com/sohn_files/wp/wordpress/wp-content/uploads/Paper-Specification-curve-2018-11-02.pdf)):
1. Sensible tests of the research question
2. Expected to be statistically valid, and
3. Not redundant with other specifications in the set.
Reproducers will be able to record two types of contributions:
- Mapping the universe of robustness checks
- Proposing a specific robustness check
]
---
background-image: url(Images/robust.svg)
background-size: 400px
background-position: 95% 95%
# Robustness & Reproducibility
.pull-left[
Robustness with level 1
<img src="Images/robustness_lvl0.svg" width="60%" style="display: block; margin: auto;" />
Robustness with levels 5-9
<img src="Images/robustness checks.svg" width="60%" style="display: block; margin: auto;" />
]
.pull-left[
Robustness with levels 2-4
<img src="Images/robustness_lvl2_4.svg" width="60%" style="display: block; margin: auto;" />
Robustness with level 10
<img src="Images/robustness_lvl10.svg" width="60%" style="display: block; margin: auto;" />
]
---
background-image: url(Images/completed_repro1.png)
background-size: 450px
background-position: 0% 0%
count:false
# Completed Reproduction: [Example](https://www.socialsciencereproduction.org/reproductions/40/published/index)
---
background-image: url(Images/completed_repro2.png), url(Images/completed_repro1.png)
background-size: 300px, 450px
background-position: 35% 0%, 0% 0%
count:false
# Completed Reproduction: [Example](https://www.socialsciencereproduction.org/reproductions/40/published/index)
---
background-image: url(Images/completed_repro3.png) ,url(Images/completed_repro2.png), url(Images/completed_repro1.png)
background-size: 600px , 300px, 450px
background-position: 100% 10%, 35% 0%, 0% 0%
count:true
# Completed Reproduction: [Example](https://www.socialsciencereproduction.org/reproductions/40/published/index)
.pull-right[
.font130[
<br><br><br><br><br><br><br>
- **Share it:** Original authors, instructors, other researchers, add it to your CV
- **Discuss it:** Discourse forum for reproductions
- **Cite it:** Reproduction DOI coming soon
]
]
---
# Promoting a Constructive Exchange
#### 1 - Contacting the original author(s) when there is no reproduction package
#### 2 - Contacting the original author(s) to request specific missing items of a reproduction package
#### 3 - Asking for additional guidance when some materials have been shared
#### 4 - Response when the original author has refused to share due to *undisclosed reasons*
#### 5 - Response when the original author has refused to share due to legal or ethical restrictions of the data
#### 6 - Contacting the original author to share the results of your reproduction exercise
#### 7 - Responding to hostile responses from original authors
#### Under development: sample responses form authors to reproducers
---
# .font80[Example 1: There is no reproduction package]
.font70[
>**Subject:** Reproduction package for `[“Title of the paper”]`
>Dear Dr. `[Lastname of Corresponding Author]`,
>
> I am contacting you to request a reproduction package for your paper titled `[Title]` which was published in `[Reference]`. A reproduction package may contain (raw and/or analytic) data, code, and other documentation that makes it possible to reproduce paper. Would you be able to share any of these items?
>
>I am a `[position]` at `[Institution]`, and I would like to reproduce the results, tables, and other figures using the reproduction materials mentioned above. I have chosen this paper because `[add context ...]`. Unfortunately, I was not able to locate any of these materials on the journal website, Dataverse `[or other data and code repositories]`, or in your website.
>
>I will record the result of my reproduction attempt on ACRE [...]. With your permission, I will also record the materials you share with me, which would allow access for other reproducers and avoid repeated requests directed to you. Please let me know if there are any legal or ethical restrictions that apply to all or parts of the reproduction materials so that I can take that into consideration during this exercise.
>
>In addition to your response above, would you be available to respond to future (non-repetitive) inquiries from me or other reproducers conducting an ACRE excercise? Though your cooperation with my and/or any future request would be extremely helpful, please note that you are *not required to comply*.
>Since I am required to complete this project by `[date]`, I would appreciate your response by `[deadline]`.
>
>Let me know if you have any questions. Please also feel free to contact my supervisor/instructor `[Name (email)]` for further details on this exercise. Thank you in advance for your help!
>
>Best regards,
>`[Reproducer]`
]
---
count:false
# .font80[Example 1: There is no reproduction package]
.font70[
>**Subject:** Reproduction package for `[“Title of the paper”]`
>Dear Dr. `[Lastname of Corresponding Author]`,
>
> I am contacting you to request a reproduction package for your paper titled `[Title]` which was published in `[Reference]`. A reproduction package may contain (raw and/or analytic) data, code, and other documentation that makes it possible to reproduce paper. Would you be able to share any of these items?
>
>I am a `[position]` at `[Institution]`, and I would like to reproduce the results, tables, and other figures using the reproduction materials mentioned above. I have chosen this paper because `[add context ...]`. **Unfortunately, I was not able to locate any of these materials on the journal website, Dataverse `[or other data and code repositories]`, or in your website**.
>
>**I will record the result of my reproduction attempt on ACRE [...]. With your permission, I will also record the materials you share with me, which would allow access for other reproducers and avoid repeated requests directed to you. Please let me know if there are any legal or ethical restrictions that apply to all or parts of the reproduction materials so that I can take that into consideration during this exercise.**
>
>In addition to your response above, would you be available to respond to future (non-repetitive) inquiries from me or other reproducers conducting an ACRE excercise? **Though your cooperation with my and/or any future request would be extremely helpful, please note that you are *not required to comply*.**
>Since I am required to complete this project by `[date]`, I would appreciate your response by `[deadline]`.
>
>Let me know if you have any questions. Please also feel free to contact my supervisor/instructor `[Name (email)]` for further details on this exercise. Thank you in advance for your help!
>
>Best regards,
>`[Reproducer]`
]
---
# .font80[Example 1: Following up on additional materials]
**Template email:**
>**Subject:** Clarification for reproduction materials for `[“Title of the paper”]`
>Dear Dr. `[Lastname of Corresponding Author]`,
>
>Thank you for sharing the materials. They have been immensely helpful for my work.
>
>Unfortunately, I ran into a few issues as I delved into the reproduction exercise, and I think your guidance would be helpful in resolving them. `[Describe the issues and how you have tried to resolve them. Describe whatever files or parts of the data or code are missing. Refer to examples 1 and 2 below for more details]`.
>
>Thank you in advance for your help.
>
>Best regards,
>`[Reproducer]`
---
count:false
# .font80[Example 1: Following up on additional materials]
**Template email:**
>**Subject:** Clarification for reproduction materials for `[“Title of the paper”]`
>Dear Dr. `[Lastname of Corresponding Author]`,
>
>Thank you for sharing the materials. They have been immensely helpful for my work.
>
>Unfortunately, I ran into a few issues as I delved into the reproduction exercise, and I think your guidance would be helpful in resolving them. **`[Describe the issues and how you have tried to resolve them. Describe whatever files or parts of the data or code are missing. Refer to examples 1 and 2 below for more details]`**.
>
>Thank you in advance for your help.
>
>Best regards,
>`[Reproducer]`
---
# An example of well described issues:
.font80[
>Specifically, I am attempting to reproduce OUTPUT X (e.g., table 1, figure 3). I found that the following components are required to reproduce to reproduce OUTPUT X:
```md
OUTPUT X
└───[code] formatting_table1.R
├───output1_part1.txt
| └───[code] output_table1.do
| └───[data] analysis_data01.csv
| └───[code] data_cleaning01.R*
| └───[data] UNKNOWN
└───output1_part2.txt
└───[code] output_table2.do
└───[data] analysis_data02.csv
└───[code] data_cleaning02.R
└───[data] admin_01raw.csv*
```
>I have marked with an asterisk (\*) the items that I could not find in the reproduction materials: data_cleaning01.R and admin_01raw.csv. After accessing these files, I will also be able to identify the name of the raw data set required to obtain output1_part1.txt. This is to let you know that I may need to contact you again if I cannot find this file (labeled as UNKNOWN above) in the reproduction materials.
>
>I understand that this request will require some work for you or somebody in your research group, but I want to assure you that I will add these missing files to the reproduction package for your paper on the ACRE platform. Doing this will ensure that you will not be asked twice for the same missing file.
]
---
count:false
# An example of well described issues:
.font80[
>Specifically, I am attempting to reproduce OUTPUT X (e.g., table 1, figure 3). I found that the following components are required to reproduce to reproduce OUTPUT X:
```md
OUTPUT X
└───[code] formatting_table1.R
├───output1_part1.txt
| └───[code] output_table1.do
| └───[data] analysis_data01.csv
* | └───[code] data_cleaning01.R*
* | └───[data] UNKNOWN
└───output1_part2.txt
└───[code] output_table2.do
└───[data] analysis_data02.csv
└───[code] data_cleaning02.R
* └───[data] admin_01raw.csv*
```
>I have marked with an asterisk (\*) the items that I could not find in the reproduction materials: **data_cleaning01.R** and **admin_01raw.csv**. After accessing these files, I will also be able to identify the name of the raw data set required to obtain output1_part1.txt. This is to let you know that I may need to contact you again if I cannot find this file (labeled as **UNKNOWN** above) in the reproduction materials.
>
>I understand that this request will require some work for you or somebody in your research group, but I want to assure you that I will add these missing files to the reproduction package for your paper on the ACRE platform. **Doing this will ensure that you will not be asked twice for the same missing file.**
]
---
background-image: url(Images/use1.png)
background-size: 500px
background-position: 0% 0%
count:false
# How Do I Get Started?
.center[
.font120[
&nbsp; &nbsp;&nbsp;&nbsp;&nbsp; [**Use it**](https://www.socialsciencereproduction.org) for your class <br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;or independent project
]
]
---
background-image: url(Images/use2.png), url(Images/use1.png)
background-size: 600px, 500px
background-position: 35% 100%, 0% 0%
count:false
# How Do I Get Started?
.center[
.font120[
&nbsp; &nbsp;&nbsp;&nbsp;&nbsp; [**Use it**](https://www.socialsciencereproduction.org) for your class <br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;or independent project
]
]
<br><br><br><br><br><br><br><br>
.font120[
Consult the <br> supporting <br>
[**guide**](https://bitss.github.io/ACRE/)
]
---
background-image: url(Images/use3.png) ,url(Images/use2.png), url(Images/use1.png)
background-size: 400px, 600px, 500px
background-position: 100% 0%, 35% 100%, 0% 0%
count:true
# How Do I Get Started?
.center[
.font120[
&nbsp; &nbsp;&nbsp;&nbsp;&nbsp; [**Use it**](https://www.socialsciencereproduction.org) for your class <br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;or independent project
]
]
<br><br><br><br><br><br><br><br>
.font120[
Consult the <br> supporting <br>
[**guide**](https://bitss.github.io/ACRE/)
]
.right[
.font120[
[**Ask**](https://forum.socialsciencereproduction.org) questions
]
]
---
class: inverse, center, middle
# .font140[ Thank You]
<html><div style='float:left'></div><hr color='#EB811B' size=1px width=100%></html>
.font190[
<acre@berkeley.edu>
]
</textarea>
<style data-target="print-only">@media screen {.remark-slide-container{display:block;}.remark-slide-scaler{box-shadow:none;}}</style>
<script src="https://remarkjs.com/downloads/remark-latest.min.js"></script>
<script>var slideshow = remark.create({
"ratio": "16:9",
"highlightStyle": "github",
"highlightLines": true,
"countIncrementalSlides": false
});
if (window.HTMLWidgets) slideshow.on('afterShowSlide', function (slide) {
window.dispatchEvent(new Event('resize'));
});
(function(d) {
var s = d.createElement("style"), r = d.querySelector(".remark-slide-scaler");
if (!r) return;
s.type = "text/css"; s.innerHTML = "@page {size: " + r.style.width + " " + r.style.height +"; }";
d.head.appendChild(s);
})(document);
(function(d) {
var el = d.getElementsByClassName("remark-slides-area");
if (!el) return;
var slide, slides = slideshow.getSlides(), els = el[0].children;
for (var i = 1; i < slides.length; i++) {
slide = slides[i];
if (slide.properties.continued === "true" || slide.properties.count === "false") {
els[i - 1].className += ' has-continuation';
}
}
var s = d.createElement("style");
s.type = "text/css"; s.innerHTML = "@media print { .has-continuation { display: none; } }";
d.head.appendChild(s);
})(document);
// delete the temporary CSS (for displaying all slides initially) when the user
// starts to view slides
(function() {
var deleted = false;
slideshow.on('beforeShowSlide', function(slide) {
if (deleted) return;
var sheets = document.styleSheets, node;
for (var i = 0; i < sheets.length; i++) {
node = sheets[i].ownerNode;
if (node.dataset["target"] !== "print-only") continue;
node.parentNode.removeChild(node);
}
deleted = true;
});
})();
(function() {
"use strict"
// Replace <script> tags in slides area to make them executable
var scripts = document.querySelectorAll(
'.remark-slides-area .remark-slide-container script'
);
if (!scripts.length) return;
for (var i = 0; i < scripts.length; i++) {
var s = document.createElement('script');
var code = document.createTextNode(scripts[i].textContent);
s.appendChild(code);
var scriptAttrs = scripts[i].attributes;
for (var j = 0; j < scriptAttrs.length; j++) {
s.setAttribute(scriptAttrs[j].name, scriptAttrs[j].value);
}
scripts[i].parentElement.replaceChild(s, scripts[i]);
}
})();
(function() {
var links = document.getElementsByTagName('a');
for (var i = 0; i < links.length; i++) {
if (/^(https?:)?\/\//.test(links[i].getAttribute('href'))) {
links[i].target = '_blank';
}
}
})();
// adds .remark-code-has-line-highlighted class to <pre> parent elements
// of code chunks containing highlighted lines with class .remark-code-line-highlighted
(function(d) {
const hlines = d.querySelectorAll('.remark-code-line-highlighted');
const preParents = [];
const findPreParent = function(line, p = 0) {
if (p > 1) return null; // traverse up no further than grandparent
const el = line.parentElement;
return el.tagName === "PRE" ? el : findPreParent(el, ++p);
};
for (let line of hlines) {
let pre = findPreParent(line);
if (pre && !preParents.includes(pre)) preParents.push(pre);
}
preParents.forEach(p => p.classList.add("remark-code-has-line-highlighted"));
})(document);</script>
<script>
slideshow._releaseMath = function(el) {
var i, text, code, codes = el.getElementsByTagName('code');
for (i = 0; i < codes.length;) {
code = codes[i];