-
Notifications
You must be signed in to change notification settings - Fork 6
/
README.Rmd
207 lines (126 loc) · 7.29 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
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
---
title: ReproHack HQ
output: github_document
always_allow_html: yes
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
echo = FALSE, knitr.kable.NA = '', message = FALSE, warning = FALSE
)
library(dplyr)
library(leaflet)
```
Welcome to the ReproHack Headquarters! :tada:
<img src="hex/reprohack.png" width=150px>
<!-- badges: start -->
[![Project Status: WIP – Initial development is in progress, but there has not yet been a stable, usable release suitable for the public.](https://www.repostatus.org/badges/latest/wip.svg)](https://www.repostatus.org/#wip) [![Slack](https://img.shields.io/badge/slack-join%20us-brightgreen)](https://reprohack-autoinvite.herokuapp.com/)
[![Newsletter](https://img.shields.io/badge/subscribe-newsletter-blueviolet?style=for-the-badge)](https://tinyletter.com/reprohack-hq)
<!-- badges: end -->
***
<br>
> ## `r emo::ji("construction")` NEW HUB UNDER CONSTRUCTION! `r emo::ji("construction")`
>
> _We are building a custom website to facilitate ReproHack activities going forwards. It is still very much under construction and buggy but hoping to have it functional by early next year._
>
> _You can [check it out](http://annakrystalli.pythonanywhere.com/) or if you have Django skills [contribute](https://github.com/reprohack/reprohack_site)!_
***
## What is a ReproHack
### A one day, hands-on Reproducibility Hackathon
We are all excited by the progress made by many authors to **make their papers reproducible by publishing associated code and data**.
We know how challenging it can be so we **want to showcase the value of the practice**, both for original authors and as a learning experience for those who attempt to reproduce the work.
## **Event format**:
During a ReproHack, **participants attempt to reproduce published research of their choice from a list of proposed papers with publicly available associated code and data**.
Participants get to work with other people's material in a low pressure environment and record their experiences on a number of key aspects, including reproducibility, transparency and reusability of materials. At the end of the day we regroup, share our experiences and give feedback to the authors.
It's imperative to note that **ReproHacks are by no means an attempt to criticise or discredit work**. We see reproduction as **beneficial scientific activity in itself**, with useful outcomes for authors and valuable learning experiences for the participants and the research community as a whole.
## **Ways to participate**
<br>
### :page_facing_up: **Propose a paper**
##### You've put a lot of effort into making your work reproducible. Now let people learn from and engage with it!
Benefits to authors:
- **Feedback** on the reproducibility of your work.
- **Appreciation** for your efforts in making your work reproducible.
- Opportunity to **engage others with your research**.
<br>
### :arrows_counterclockwise: :white_check_mark: **Reproduce**
##### Join us at the ReproHack and get working with other people's material.
Benefits to participants:
- **Practical experience in reproducibility** with real published materials and the opportunity to explore different tools and strategies.
- **Inspiration** from working with other people’s code and data.
- An appreciation that **reproducibility is non trivial** but that opening up your work for more people to engage with is the best way to help improve it.
- An appreciation that **reproducibility has community value beyond just the validation of the results**. For example, access to such materials increases the potential for reuse and understanding of the work.
**Benefits to the whole research community:**
- Assessment of how reproducible papers are ‘out of the box’.
- Evaluation of how successful current practices are and for what purpose.
- Identification of what works and where the most pressing weaknesses in our approaches are.
***
## Contributing
### Run a ReproHack!
Please get in touch if you would like to run a ReproHack. We are working to make materials more reusable and easier to reproduce and also on developing guidance on organising and running an event so that in future folks will be able to run everything independently.
There are currently [reusable materials](https://github.com/reprohack/reprohack-template-shiny) and [instructions for organisers](organiser_instructions.md). However, there are plans to streamline the materials & workflow. At this stage, we also really appreciate contact with organisers in order to both help and to learn from their experiences.
### Hack the ReproHack!
There are a [number of topics](dev_directions.md) we are working on to improve the events and make them reproducible and scalable. Details on the main development directions can be found in the on the
See [Roadmap]() for more details on milestones
<br>
***
# Upcoming Reprohacks
```{r}
event_log <- readr::read_csv("data/event-log.csv") %>%
mutate(upcoming = date >= Sys.Date()) %>%
mutate(title = glue::glue("[{title}]({url})"))
event_log %>%
filter(upcoming == TRUE) %>%
select(-lat, - lon, -upcoming, -room, -address, -url) %>%
arrange(date) %>%
knitr::kable()
```
## Past Reprohacks
```{r}
event_log %>%
filter(upcoming == FALSE) %>%
select(-lat, - lon, -upcoming, -room, -address, -url) %>%
arrange(date) %>%
knitr::kable()
```
## Map of Reprohacks
```{r map}
plot_log <- event_log %>%
mutate(color = case_when(upcoming == TRUE ~ "green",
upcoming == FALSE ~ "orange"))
#pal <- colorFactor(c("green", "orange"), c(FALSE, TRUE))
icons <- awesomeIcons(
icon = 'ios-close',
iconColor = 'black',
library = 'ion',
markerColor = plot_log$color
)
plot_log %>%
leaflet() %>%
addProviderTiles("CartoDB.Positron") %>%
addAwesomeMarkers(icon = icons) #%>%
#addLegend("bottomright", pal = pal, values = ~upcoming,
#opacity = 0.7)
```
***
## More on the ReproHack:
- **Blogpost**: [ReproHacking at Opencon London 2017 Doathon](https://rse.shef.ac.uk/blog/opencon-london/)
- **Blogpost**: [Reprohacking at CarpentryConnect Manchester 2019](https://software.ac.uk/blog/2019-08-07-reprohacking-carpentryconnect-manchester-2019)
- **Comunity Call**: Section on ReproHack on [Reproducible Research with R, rOpenSci Community Call](https://vimeo.com/351259131)
- **Blogpost**: [Reproducibility Hackathon Netherlands – the aftermath](https://www.software.ac.uk/blog/2020-01-15-reproducibility-hackathon-netherlands-aftermath)
- **Blogpost**: [N8 CIR ReproHack Northern Tour - Winter 2020](https://n8cir.org.uk/news/reprohacks/)
## Many ways to ReproHack!
![](assets/workflow.png)
***
<br>
[![Slack](https://img.shields.io/badge/slack-join%20us-brightgreen)](https://reprohack-autoinvite.herokuapp.com/)
### Subscribe to our Newsletter
[![Newsletter](https://img.shields.io/badge/subscribe-newsletter-blueviolet?style=for-the-badge)](https://tinyletter.com/reprohack-hq)
## Team
- [Florencia D’Andrea](https://github.com/flor14)
- [Daniela Gawehns](https://github.com/DanielaGawehns)
- [Anna Krystalli](https://github.com/annakrystalli)
- [Linda Nab](https://github.com/LindaNab)
- [Ricarda Proppert](https://github.com/RicardaP)
- [Paloma Rojas Saunero](https://github.com/palolili23)