diff --git a/ReproHack.png b/ReproHack.png new file mode 100644 index 0000000..50ed623 Binary files /dev/null and b/ReproHack.png differ diff --git a/guidelines.html b/guidelines.html new file mode 100644 index 0000000..2732731 --- /dev/null +++ b/guidelines.html @@ -0,0 +1,507 @@ + + + + + + + + + + + + + + +Organiser Instructions + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + +
+

There are different types of reproHacks

+

+
+
+

Do you want to run a reproHack?

+

First check our code of conduct You must care for a friendly atmosphere for everyone

+

Join our Slack! we can give you support during the process of organising your own reproHack

+
+
+

1. Pre-Event

+
+

Some weeks in advance

+
+

Find a location for the event

+

You will need to find a place with facilities for plug in the laptops of the attendees

+
+
+

Publicite the event

+

You can use our twitter account including @reproHack

+
    +
  • Submission Form
    • +
+

The most important preparation to run a Reprohack is to collate a paper list for participants to choose from. Inviting contributions from authors requires a form through which they can submit details of their papers and a web page to present the paper list. A way of collecting and communicating particpant feedback to authors is also required.

+

We have a Paper submission form for authors to want to submit their papers to be reproduced during the reproHack

+
+
+

Good practices

+

Send an email - message remembering people who want to attend the reprohack hour and location some days in advance

+

+
+
+
+

Day of the Event

+
+

Paper posting

+

We paste relevant information about each paper on a wall or frieze to make it easier for participants to choose which paper they want to reproduce. These printings have information that the authors send in the submission form that includes for example the programming languages used in that paper. If the paper has already been reproduced at least once, a reproducibility score is included that can help participants understand the reproducibility of the paper. This generates a moment of conversation among those who attend.

+

+
+
+

Preparing the snacks

+

Picture?

+
+
+

Sponsors

+

I you got any sponsor for the reproHack it is a good practise to tweet about them during the event or make available its material.

+
+
+

Stickers

+

People really like stickers! If you have the opportunity, here is the one of reproHack ready to be printed for your event!

+

+
+
+
+
+

2. Event

+
+

Introductions and Slides

+

Welcome the people. It is a good idea to encourage attendees to form mixed groups to reproduce the papers. We suggest groups of two persons, but this is up to the personal choice of the participants

+

Here some template slides: Slides

+
+
+

Helpers

+

If it is staff people available, it is a good idea to ask the participants if they need some help during the process. No technical skills are needed for this, it is just to keep the hackathon going. Remember that ideally, a paper should be reproducible for anyone who wants to have access to that information. If any participant has fewer skills about the research topic of the paper and this became a problem for reproducibility or lack of experience with tools as docker, that is also relevant information to the authors that could be included in the feedback form.

+
+
+

Breaks

+

Reprohacks promotes a relaxed atmosphere, so we suggest leaving food and beverages free during the event. No breaks are needed with exception of lunch.

+
+
+

Let’s share our impressions about reproducibility

+

Sharing opinions about the papers being reproduced could lead to good sharing and interesting discussions. Before lunch and as final activity could be good moments for this.

+
+
+

Feedback Form

+

It is important that the participants fill the feedback form to the authors after they finish their (successful or not) attempt to reproduce the paper.

+

Author feedback form

+
+
+

End of the event

+

We encourage to get feedback of the participants.

+
    +
  • What do they like?
    • +
  • Which suggerences do they have to improve reproHacking?
    • +
+

You can use post its as an easy way to get the information from the participants.

+
+
+ + + + +
+ + + + + + + + + + + + + + + diff --git a/guidelines/ReproHack.png b/guidelines/ReproHack.png new file mode 100644 index 0000000..50ed623 Binary files /dev/null and b/guidelines/ReproHack.png differ diff --git a/guidelines/guidelines.Rmd b/guidelines/guidelines.Rmd new file mode 100644 index 0000000..a911238 --- /dev/null +++ b/guidelines/guidelines.Rmd @@ -0,0 +1,142 @@ +--- +title: "Organiser Instructions" +author: "reproHack Team" +date: "12/3/2020" +output: html_document +--- + + +#### There are different types of reproHacks + + +```{r reprohack, echo=FALSE, fig.align='center', out.width="50%"} +knitr::include_graphics("ReproHack.png") +``` + +#### **Do you want to run a reproHack?** + +The most important preparation to run a Reprohack is to collate a paper list for participants to choose from. Inviting contributions from authors requires a form through which they can submit details of their papers and a web page to present the paper list. A way of collecting and communicating particpant feedback to authors is also required. + +First check our [code of conduct](https://github.com/reprohack/reprohack-hq/blob/master/CODE_OF_CONDUCT.md) You must care for a friendly atmosphere for everyone + +Join our [Slack]()! we can give you support during the process of organising your own reproHack + +### 1. Pre-Event + +#### **Some weeks before** + +##### Find a location for the event + +You will need to find a place with facilities for plug in the laptops of the attendees + +```{r room, echo=FALSE, fig.align='center', out.width="30%"} +knitr::include_graphics("room.jpg") +``` + +##### Publicite the event + +You can use our twitter account including `@reproHack` + +##### Organiser checklist + +To make use of the current materials and templates to organise a ReproHack, please follow this organiser template. Feel free to reach out if anything is unclear. The workflow is easiest through [Rstudio](https://www.rstudio.com/) + +- [ ] Copy template repository [**`reprohack-template-shiny`**](https://github.com/reprohack/reprohack-template-shiny). Name the repository: `reprohack--YYYY-MM-DD`. + +- [ ] Make copies of the two googleforms, one for collecting paper submissions and one for collecting feedback + + [paper submission form](https://drive.google.com/open?id=1-Q-dQQu47ytCg2Z7F99hzCSxewLCbPUi8UlZWg0JYjI) + + [author feedback form](https://drive.google.com/open?id=1KRooOAtbmOzIES1h2T9Gvt7AaPFLDS0BQUZRiimJZSU) + +- [ ] Create a hackpad (eg etherpad, hack.md, googledoc) for collaborative notetaking at the event (optional) + + you can use this [hackmd.io template](https://hackmd.io/@annakrystalli/reprohack-hackpad-tmpl) if you wish + +- [ ] Get geographical coordinates for venue (e. g. using [latlong.net](https://www.latlong.net/)). + +- [ ] Complete parameters in YAML header of `index.Rmd` & `README.Rmd`. + - [ ] Knit `README.Rmd` and push to GitHub. + - [ ] [Deploy](https://bookdown.org/yihui/rmarkdown/shiny-deploy.html) `index.Rmd` on shinyapps.io. (More on [getting started with shinyapps.io](https://shiny.rstudio.com/articles/shinyapps.html)). Running the document also prompts you to authenticate with google which produces an `.httr-oauth` authorisation token. You will need to deploy: + - `index.Rmd` and + - `.httr-oauth` (required to access the paper list on googlesheets) + - `reprohack-css` + - any other assets used eg if an event banner is being used. + You can also deploy programmatically with the following example code: + +```{r eval=FALSE, include=TRUE} + rsconnect::deployApp(appName = "ReproHack_CCMcr", + appTitle = "ReproHack Carpentry Connect Manchester", + account = "annakrystalli", appFiles = c("index.Rmd", + ".httr-oauth", + "reprohack.css", + "CCmcrlogo.png")) +``` + +- [ ] Edit and upload `slides.md` containing the introductory to [hackmd.io](https://hackmd.io/) and [set to slide view](https://hackmd.io/s/features#Import-Notes). + - [ ] update slides url in the `README.md` agenda + + +##### Remember! + +Send an email - message remembering people who want to attend the reprohack hour and location some days in advance + +#### **Day of the Event** + +##### Paper posting + + **We paste relevant information about each paper on a wall or frieze to make it easier for participants to choose which paper they want to reproduce.** These printings have information that the authors send in the submission form that includes for example the programming languages used in that paper. + If the paper has already been reproduced at least once, a reproducibility score is included that can help participants understand the reproducibility of the paper. +This generates a moment of conversation among those who attend. + +```{r posting, echo=FALSE, fig.align='center', out.width="30%"} +knitr::include_graphics("posting.jpg") +``` + +#### Sponsors + +I you got any sponsor for the reproHack it is a good practise to tweet about them during the event or make available its material. + +#### Stickers + +People love stickers! If you have the opportunity, [here](https://github.com/flor14/reprohack-hq/tree/master/hex) reproHack hex sticker ready to be printed for your event! + +```{r sticker, echo=FALSE, fig.align='center', out.width="30%"} +knitr::include_graphics("sticker.jpg") +``` + +### **2. Event** + +#### Introductions and Slides + +Welcome the people. + **It is a good idea to encourage attendees to form mixed groups to reproduce the papers.** We suggest groups of two persons, but this is up to the personal choice of the participants + +#### Helpers + + **If it is staff people available, it is a good idea to ask the participants if they need some help during the process.** No technical skills are needed for this, it is just to keep the hackathon going. Remember that ideally, a paper should be reproducible for anyone who wants to have access to that information. If any participant has fewer skills about the research topic of the paper and this became a problem for reproducibility or lack of experience with tools as docker, that is also relevant information to the authors that could be included in the feedback form. + +#### Breaks + + **Reprohacks promotes a relaxed atmosphere, so we suggest leaving food and beverages free during the event.** No breaks are needed with exception of lunch. + +#### Let’s share our impressions about reproducibility + + **Sharing opinions about the papers being reproduced could lead to good sharing and interesting discussions.** Before lunch and as final activity could be good moments for this. + +#### Feedback Form + + **It is important that the participants fill the feedback form** to the authors after they finish their (successful or not) attempt to reproduce the paper. + +[Author feedback form](https://docs.google.com/forms/d/e/1FAIpQLSembkNEg3qN0SKxmf6cR4z2Cla47pOhfZ9GCKh5J9KUi1wpcw/viewform) + +#### End of the event + +We encourage to get feedback of the participants. + +* What do they like? +* Which suggerences do they have to improve reproHacking? + +You can use post its as an easy way to get the information from the participants. + +### **3. After the event** + + + diff --git a/guidelines/guidelines.html b/guidelines/guidelines.html new file mode 100644 index 0000000..90ec46b --- /dev/null +++ b/guidelines/guidelines.html @@ -0,0 +1,545 @@ + + + + + + + + + + + + + + +Organiser Instructions + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + + + + +
+

There are different types of reproHacks

+

+
+
+

Do you want to run a reproHack?

+

The most important preparation to run a Reprohack is to collate a paper list for participants to choose from. Inviting contributions from authors requires a form through which they can submit details of their papers and a web page to present the paper list. A way of collecting and communicating particpant feedback to authors is also required.

+

First check our code of conduct You must care for a friendly atmosphere for everyone

+

Join our Slack! we can give you support during the process of organising your own reproHack

+
+
+

1. Pre-Event

+
+

Some weeks before

+
+
Find a location for the event
+

You will need to find a place with facilities for plug in the laptops of the attendees

+

+
+
+
Publicite the event
+

You can use our twitter account including @reproHack

+
+
+
Organiser checklist
+

To make use of the current materials and templates to organise a ReproHack, please follow this organiser template. Feel free to reach out if anything is unclear. The workflow is easiest through Rstudio

+
    +

  • +Copy template repository reprohack-template-shiny. Name the repository: reprohack-<location>-YYYY-MM-DD.

    • +
  • +Make copies of the two googleforms, one for collecting paper submissions and one for collecting feedback
    • +
  • +Create a hackpad (eg etherpad, hack.md, googledoc) for collaborative notetaking at the event (optional)
    • +

  • +Get geographical coordinates for venue (e. g. using latlong.net).

    • +
  • +Complete parameters in YAML header of index.Rmd & README.Rmd.
      +
    • +Knit README.Rmd and push to GitHub.
      • +
    • +Deploy index.Rmd on shinyapps.io. (More on getting started with shinyapps.io). Running the document also prompts you to authenticate with google which produces an .httr-oauth authorisation token. You will need to deploy:
        +
      • index.Rmd and
        • +
      • .httr-oauth (required to access the paper list on googlesheets)
        • +
      • reprohack-css
        • +
      • any other assets used eg if an event banner is being used. You can also deploy programmatically with the following example code:
        • +
      • +
    • +
+
      rsconnect::deployApp(appName = "ReproHack_CCMcr",
+                     appTitle = "ReproHack Carpentry Connect Manchester",
+                     account = "annakrystalli", appFiles = c("index.Rmd", 
+                                                             ".httr-oauth",
+                                                             "reprohack.css",
+                                                             "CCmcrlogo.png"))
+
    +
  • +Edit and upload slides.md containing the introductory to hackmd.io and set to slide view.
      +
    • +update slides url in the README.md agenda
      • +
    • +
+
+
+
Remember!
+

Send an email - message remembering people who want to attend the reprohack hour and location some days in advance

+
+
+
+

Day of the Event

+
+
Paper posting
+

We paste relevant information about each paper on a wall or frieze to make it easier for participants to choose which paper they want to reproduce. These printings have information that the authors send in the submission form that includes for example the programming languages used in that paper. If the paper has already been reproduced at least once, a reproducibility score is included that can help participants understand the reproducibility of the paper. This generates a moment of conversation among those who attend.

+

+
+
+
+

Sponsors

+

I you got any sponsor for the reproHack it is a good practise to tweet about them during the event or make available its material.

+
+
+

Stickers

+

People love stickers! If you have the opportunity, here reproHack hex sticker ready to be printed for your event!

+

+
+
+
+

2. Event

+
+

Introductions and Slides

+

Welcome the people. It is a good idea to encourage attendees to form mixed groups to reproduce the papers. We suggest groups of two persons, but this is up to the personal choice of the participants

+
+
+

Helpers

+

If it is staff people available, it is a good idea to ask the participants if they need some help during the process. No technical skills are needed for this, it is just to keep the hackathon going. Remember that ideally, a paper should be reproducible for anyone who wants to have access to that information. If any participant has fewer skills about the research topic of the paper and this became a problem for reproducibility or lack of experience with tools as docker, that is also relevant information to the authors that could be included in the feedback form.

+
+
+

Breaks

+

Reprohacks promotes a relaxed atmosphere, so we suggest leaving food and beverages free during the event. No breaks are needed with exception of lunch.

+
+
+

Let’s share our impressions about reproducibility

+

Sharing opinions about the papers being reproduced could lead to good sharing and interesting discussions. Before lunch and as final activity could be good moments for this.

+
+
+

Feedback Form

+

It is important that the participants fill the feedback form to the authors after they finish their (successful or not) attempt to reproduce the paper.

+

Author feedback form

+
+
+

End of the event

+

We encourage to get feedback of the participants.

+
    +
  • What do they like?
    • +
  • Which suggerences do they have to improve reproHacking?
    • +
+

You can use post its as an easy way to get the information from the participants.

+
+
+
+

3. After the event

+
+ + + + +
+ + + + + + + + + + + + + + + diff --git a/guidelines/posting.jpg b/guidelines/posting.jpg new file mode 100644 index 0000000..dfc4f7d Binary files /dev/null and b/guidelines/posting.jpg differ diff --git a/guidelines/reproHack.Rproj b/guidelines/reproHack.Rproj new file mode 100644 index 0000000..968de24 --- /dev/null +++ b/guidelines/reproHack.Rproj @@ -0,0 +1,16 @@ +Version: 1.0 + +RestoreWorkspace: Default +SaveWorkspace: Default +AlwaysSaveHistory: Default + +EnableCodeIndexing: Yes +UseSpacesForTab: Yes +NumSpacesForTab: 2 +Encoding: UTF-8 + +RnwWeave: Sweave +LaTeX: pdfLaTeX + +AutoAppendNewline: Yes +StripTrailingWhitespace: Yes diff --git a/guidelines/room.jpg b/guidelines/room.jpg new file mode 100644 index 0000000..5f62c76 Binary files /dev/null and b/guidelines/room.jpg differ diff --git a/guidelines/sticker.jpg b/guidelines/sticker.jpg new file mode 100644 index 0000000..71f2ae1 Binary files /dev/null and b/guidelines/sticker.jpg differ diff --git a/posting.jpg b/posting.jpg new file mode 100644 index 0000000..dfc4f7d Binary files /dev/null and b/posting.jpg differ diff --git a/reproHack.Rproj b/reproHack.Rproj new file mode 100644 index 0000000..968de24 --- /dev/null +++ b/reproHack.Rproj @@ -0,0 +1,16 @@ +Version: 1.0 + +RestoreWorkspace: Default +SaveWorkspace: Default +AlwaysSaveHistory: Default + +EnableCodeIndexing: Yes +UseSpacesForTab: Yes +NumSpacesForTab: 2 +Encoding: UTF-8 + +RnwWeave: Sweave +LaTeX: pdfLaTeX + +AutoAppendNewline: Yes +StripTrailingWhitespace: Yes diff --git a/room.jpg b/room.jpg new file mode 100644 index 0000000..5f62c76 Binary files /dev/null and b/room.jpg differ diff --git a/sticker.jpg b/sticker.jpg new file mode 100644 index 0000000..71f2ae1 Binary files /dev/null and b/sticker.jpg differ