Skip to content

Commit cf6c540

Browse files
committed
add Binder badges and info to README
1 parent ead6328 commit cf6c540

File tree

1 file changed

+21
-13
lines changed

1 file changed

+21
-13
lines changed

README.md

Lines changed: 21 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,16 @@ This is a supplemental resource to Leipzig et al. "The Role of Metadata in Repro
1010
│ ├───lens/ Search exports for scimetric journal analysis
1111
│ └───standards.tsv Raw standards table
1212
├───src/
13+
│ ├───cwl/tools/ CWL configuration to produce the timeline plot
14+
│ ├───manuscript/ Manuscript revision document
1315
│ ├───secrets/
1416
│ │ └───api.template.py Replace this with api.py using your NCBI/NCBO keys
15-
│ ├───ncbo_ontologies.py Scimetric ontology popularity analysis
16-
│ ├───scimetric.ipynb Scimetric journal meta/rcr frequency analysis
17-
│ ├───timeline.R Produces the RCR case study timeline in the paper
17+
│ ├───ontologies/ Scimetric ontology popularity analysis
18+
│ ├───repotutils/ Scripts for automating management of this repository
19+
│ ├───scimetric/ Scimetric journal meta/rcr frequency analysis in a Jupyter Notebook
20+
│ ├───timeline/ R Markdown document to produce the RCR case study timeline in the paper, incl. helper files for execution with CWL (wrapper script, Dockerfile)
1821
│ ├───wget2jsonld.py Helper script to convert wget output to jsonld
19-
│ └───wordcloud.R Produces word cloud from cited abstracts
22+
│ └───wordcloud/ R script to produce word cloud from cited abstracts
2023
├───LICENSE The LICENSE file
2124
├───README.md What you are looking at
2225
├───environment.osx.yaml OSX pinned Conda depenencies
@@ -100,12 +103,25 @@ https://stackoverflow.com/questions/1740341/what-is-the-difference-between-rdf-a
100103
## How to generate the timeline for this article
101104

102105
Install [cwltool](https://github.com/common-workflow-language/cwltool)
106+
103107
```
104108
pip install cwltool
105109
cwltool src/cwl/tools/timeline.cwl --reportfile timeline.html
106110
```
107111

108-
**Using repo2docker:**
112+
Note that the tools requires Docker for runningthe computing environment, see the file `timeline/Dockerfile` for the definition of the image used in the `.cwl` file.
113+
114+
## Run on Binder
115+
116+
[MyBinder](https://mybinder.org/) is a tool for creating executable computing environments based on standard and widely used dependency management files.
117+
You can easily run important parts of the analysis for the manuscript by clicking on the badges below.
118+
Binder will create a container using the environment configuration from the directory `.binder/` and provide you with an interactive environment to execute notebooks or scripts.
119+
120+
- Scimetric journal frequency analysis of RCR and metadata terms (opens a Jupyter Notebook) [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/leipzig/metadata-in-rcr/HEAD?filepath=src%2Fscimetric%2Fscimetric.ipynb)
121+
- Create Figure 2 from the paper (R Markdown notebook, open the file `src/timeline/timeline.Rmd` manually in RStudio) [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/leipzig/metadata-in-rcr/HEAD?urlpath=rstudio)
122+
- Create word cloud from cited abstracts (run R script `src/wordcloud/wordcloud.R`) [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/leipzig/metadata-in-rcr/HEAD?urlpath=rstudio)
123+
124+
For development purposes, you can also run `repo2docker` locally in the directory of the repository.
109125

110126
```bash
111127
repo2docker --editable .
@@ -118,11 +134,3 @@ Contributions welcome!
118134
## License
119135

120136
[![CC0](http://mirrors.creativecommons.org/presskit/buttons/88x31/svg/cc-zero.svg)](https://creativecommons.org/publicdomain/zero/1.0/)
121-
122-
123-
124-
125-
126-
127-
128-

0 commit comments

Comments
 (0)