An open API service indexing awesome lists of open source software.

https://github.com/gesiscss/widd-example


https://github.com/gesiscss/widd-example

Last synced: about 1 year ago
JSON representation

Awesome Lists containing this project

README

          

# widd-example

We provide an overview of the usage of Workflow integrated Data Documentation.

The project is intended for demonstration purposes only. To test WIDD in a working environemnt, click on the LaunchBinder-button below and follow the steps outlined in the How to use section.

## How to use

1. Open the `widd_demo.ipynb` file.
2. Create a new cell in the markdown format that you want to use for data documentation.
3. Click on WIDD in the taskbar and hover over "SAGE WIDD".
4. Choose a category from which you would like to select a documentation question. Once you click on it, the question is pasted into the selected markdown cell.
5. Repeat steps 2 to 5, creating a new cell for each documentation question you would like to answer.
6. Click the "Create WIDD"-button and insert a name.
7. By clicking "OK", the a markdown-file containing the documentation questions as well as your answers is created and downloaded.

## Online Analysis Environment
[![GESIS Notebooks](https://notebooks.gesis.org/static/images/logo/logo_text.png)](https://notebooks.gesis.org)

You can execute the project online at [GESIS Notebooks](https://notebooks.gesis.org/)

+ To launch the analysis for one-time usage click
[![Binder](https://notebooks.gesis.org/binder/badge.svg)](https://notebooks.gesis.org/binder/v2/gh/gesiscss/widd-example/HEAD?urlpath=notebooks)

## Terms of Use

Materials are licensed under [CC BY-SA 4.0](http://creativecommons.org/licenses/by-sa/4.0/).

[![Creative Commons Lizenzvertrag](https://i.creativecommons.org/l/by-sa/4.0/88x31.png)](http://creativecommons.org/licenses/by-sa/4.0/)