Reproducible research and GIScience: Computational Environment
Ready to use R Markdown notebook for the paper "Reproducible research and GIScience: an evaluation using AGILE conference papers".
Click the "Binder" button below to open the notebook on binder.org.
On the Jupyter page that opens, select "New > RStudio".
In RStudio, open the file
agile-rr-paper-corpus.Rmd, the main analysis file.
Then select "Knit > Knit to HTML" to render the document, which includes the complete analysis workflow, and display it in your browser. You may use other output formats, like PDF, which is needed to create the figures for the original article.
For all analysis code to work you have to complete two prerequisite steps as described in the main analysis file:
- Configure a Springer API key
- Upload data to the workspace (alternatively: download sample data, see main analysis file section "Data")
Wihtout data and API key, only some figures can be reproduced.
Open the main analysis file
agile-rr-paper-corpus.Rmd with RStudio.
Then select "Knit > Knit to PDF" to render the document.
If you have errors rendering the whole PDF, try running each chunk to locate the problem or use "Knit to HTML".
The document does not include code to install required packages.
Run the code in the file
install.R to install all dependencies.
You can skip the installation of
tinytex and the LaTeX packages if you knit to HTML or run the chunks directly from RStudio.
Reproduce locally with Docker
Install Docker CE or a compatible tool for building an image based on a
Dockerfile and running a container based on the image.
Download the project files, open a command line in the root directory (where this file is), and run the following commands:
# build the image docker build --tag rr-giscience . # run the image docker run -it -p 8888:8888 rr-giscience
Open a browser at http://localhost:8888 or click on the login link shown in the console. It will show the Jupyter start page as shown in the first screenshot of the instructions in Reproduce online, which you can use as described in that section.
Files in this repository
Paper_Evaluation.csv: Results of manual paper evaluation.
Reproducibility_Survey.csv: Anonymised responses of author survey.
agile-rr-paper-corpus.Rmd: R Markdown document with the code to conduct the analysis and create the figures of the paper.
agile-rr-paper-corpus.pdf: A PDF rendering or he analysis document for viewing.
Dockerfile: A recipe for the computational environment using Docker.
install.R: R script file executed during creation of the Docker image to install required dependencies.
Deposition on Zenodo
This repository is archived on Zenodo: https://doi.org/10.5281/zenodo.1227260
The Zenodo repository includes the complete git repository so that readers may investigate the history of the analysis starting with the supplemental information of the PeerJ preprint.
The deposited archive was created based on the tag
6 (matching the Zenodo version number) with the following commands:
git clone https://github.com/nuest/reproducible-research-and-giscience.git cd reproducible-research-and-giscience git checkout 6 zip -r reproducible-reserach-and-giscience.zip .
The documents in this repository are licensed under a Creative Commons Attribution 4.0 International License.
All contained code is licensed under the Apache License 2.0.
The data used is licensed under a Open Data Commons Attribution License.