Commit 17e213a8 authored by Salman Khalid's avatar Salman Khalid

About page

parent 5595cb90
......@@ -47,33 +47,50 @@
<div class="container">
<h1> About the project </h1>
<h2>The topic</h2>
<p>The goal of this project is to produce Geobadges for Reproducible Research, this means creating badges that help in making research reproducible.
The badges should e.g. explain the reproducibility of any research, for example to check if the research is peer-reviewed, licensed, executable etc.
To improve the reproducibility in computational geosciences, the research project Opening Reproducible Research (o2r, http://o2r,info ) develops a
new solution to package all components of research called executable research compendia (ERC). The task in this study project is to create a badge ecosystem for ERC.
For ERC to become a real game changer in computational geosciences, they must be integrated into existing platforms for managing research data, code, and
publications. For ERC to thrive (to be accepted by researchers and funding agencies), they must provide licensing information for all parts of a compendium:
software, (geospatial) data, and text. This project analysed how to aggregate the licensing information available in ERC metadata into badges with a particular
eye on specifics of geospatial data.</p>
<h2>Why badges?</h2>
<p>This project aims to create badges that helps making research reproducible.
That is, the badges will explain the state of any component (for example data, code and articles) in a research
so that it can be understood by others when they have a look at it later and possibly even build upon it.
The badges aim to display the state of key factors about the research such that the output is very evident and presented right at the face of it.</p>
<p>The results are presented in an interactive manner that gives the display of the badge an even better meaning.
The results are provided with a certain colored background which depends on the type of output. For example a positive result is shown with a Green color,
a negative result is shown with a Red color and intermediate results are sometimes in Yellow or Orange color, again depending upon the specific type of outcome.</p>
<p>In this project key aspects about a research that a user is interested in knowing are represented evidently on the badges.
For example a user might want to know if a research is peer-reviewed or not, in order to get an idea about the quality of the research.
Similarly a user might also be interested to know about the licensing or the executibility of a code in a research.
These important factors along with some more are displayed on the badges along with their results.</p>
<h2>Why badges?</h2>
<p>Nowadays, we get into contact with badges nearly everyday, e.g in software development communities (see <a href="" target="_blank"></a>) and digital learning (see <a href="" target="_blank"></a>)
Badges provide a concise, recognizable yet useful piece of information, such as the build state or the number of downloads.
<h2>Predefined tasks</h2>
<li>What are the most important information to put into (static, interactive) the badges?</li>
<li>Which (open, closed) platforms would profit from the badges and how can badges be integrated seamlessly for users? Which of them are most relevant for geospatial research?</li>
<li>What kind of interactivity could be integrated into badges?</li>
<li>How can spatio-temporal information be conveyed effectively via badges?</li>
<li>How can badge publication be automated (e.g. added to GitHub repos or to Tweets)?</li>
<li>How do badges work with the differen ERC levels and the publication process?</li>
Major challenges:
<li>developing algorithms to aggregate complex information (e.g. spatio-temporal extent, licenses) into badge-ready information</li>
<li>working with real-world applications in different programming languages</li>
<li>extend the approach into closed systems (e.g. Mendeley, ScienceDirect, PLOS, Google Scholar, Microsoft Academic Search)</li>
<h2>Our API</h2>
<p>There is part of API that is same for every task. That base part is as following:</p>
<p>The rest of the API is case dependent. The structure would be dependent on the name of the task, platform from which metadata of a research is taken,
the id for calling a particular research compendium and a final addition which is optional in case you want to request a big badge, is the keyword "extended".
Example APIs are provided below:</p>
<p>/api/1.0/badge/licence/o2r/id/extended (returns a big badge)</p>
<img src="images/license_noData_code.svg" /></br>
<p>/api/1.0/badge/licence/o2r/id (returns a small badge)</p>
<img src="images/shields_io/licence_partially_open.svg" /></br></br>
<p>This is an example from the licensing task. Let us have a look at another example from the executibility task:</p>
<p>/api/1.0/badge/executable/o2r/id/extended (returns a big badge)</p>
<img src="images/executible.png" /></br></br>
<p>/api/1.0/badge/executable/o2r/id (returns a small badge)</p>
<img src="images/shields_io/executable-yes-brightgreen.svg" /></br></br>
<h1>The Team</h1>
......@@ -82,7 +99,7 @@
Antonia van Eek, Clara Rendel, Lasse Einfeldt, Laura Meierkort, Marlena Götza, Salman Khalid, Shahzeib Tariq Jaswal, Nimrod Gavish, Matthias Mohr, Daniel Nüst
<h1>Gitlab Link</h1>
<a href="" target="_blank">Here </a>you can find the link to the Gitlab repository with the code of the project. </br>
<a href="" target="_blank">Here </a>you can find the link to the Gitlab repository with the code of the project. </br></br></br>
Markdown is supported
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment