Reuse and adapt DataArc's code and expand your toolkit with the API

Code Base

All code developed for the DataArc Project is available open access. It is free to reuse and adapt under a creative commons license.

The source code for the search tool is at: https://github.com/castuofa/dataarc-ui

Technical documentation for the 'Why' section is here.

The API code is at: https://github.com/castuofa/dataarc-api

The datasets and metadata used in the tool are at: https://github.com/castuofa/dataarc-source

 

Data Preparation Code

The data for the Icelandic Saga Map and other related Sagas datasets are created by tagging the text with relevant concepts in Microsoft word. These documents are saved as XML, which is then converted to geoJSON for import into dataARC. The code to convert from XML to geoJSON is available at: https://github.com/ropitz/docx-geojson-sagamap .

API

The DataArc search tool is built on an API. This same API can be used to carry out advanced analyses and queries and to visualise data in jupyter or R notebooks, or to pull data from DataArc into your own project's infrastructure.

The API technical documentation is at: https://api.data-arc.org/documentation/. A brief API help guide is available at: https://dataarc-demo.readthedocs.io/en/latest/dataarc-api.html.

Use the graphql playground at: https://api.data-arc.org/graphql  to test your queries and learn to use the API.

You can see examples of the API in use in our project's jupyter notebooks like this one which looks at the levels of connectedness between concepts used in the project and this one which provides a basic example of how to use a jupyter  notebook and the API to extract connected data.