https://github.com/rmax/databrewer-recipes

DataBrewer Recipes Repository.
https://github.com/rmax/databrewer-recipes

data datasets

Last synced: 11 months ago
JSON representation

DataBrewer Recipes Repository.

• Host: GitHub
• URL: https://github.com/rmax/databrewer-recipes
• Owner: rmax
• License: other
• Created: 2016-07-01T02:31:40.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2016-07-05T01:53:43.000Z (over 9 years ago)
• Last Synced: 2025-03-17T18:33:58.023Z (11 months ago)
• Topics: data, datasets
• Language: Python
• Homepage: https://databrewer.readthedocs.org/
• Size: 912 KB
• Stars: 20
• Watchers: 3
• Forks: 9
• Open Issues: 66
• Metadata Files:
  • Readme: README.rst

Awesome Lists containing this project

README

          
==================

DataBrewer Recipes

==================

.. image:: https://readthedocs.org/projects/databrewer/badge/?version=latest

        :target: https://readthedocs.org/projects/databrewer/?badge=latest

        :alt: Documentation Status

.. image:: https://img.shields.io/pypi/v/databrewer.svg

        :target: https://pypi.python.org/pypi/databrewer

.. image:: https://img.shields.io/travis/rolando/databrewer-recipes.svg

        :target: https://travis-ci.org/rolando/databrewer-recipes

DataBrewer Recipes Repository.

* Free software: MIT license

* Documentation: https://databrewer.readthedocs.org.

* Project: https://github.com/rolando/databrewer

What is this?

-------------

This is a collection of dataset recipes, that is, a simple description of where

to find existing datasets archives.

The recipes itself are licensed under MIT license. Each dataset may have its

own licensing and usage restrictions.

This recipes are used by the ``databrewer`` tool. See https://github.com/rolando/databrewer

Contributing

------------

You can contribute in several ways, for example:

* `Requesting additions of new datasets `_.

* `Reporting errors in existing datasets `_.

* Adding new recipes for interesting datasets.

* Improving existing recipes: better descriptions, keywords, fixing URLs, etc.

Recipes Guidelines

------------------

* The ``name`` fields must be all lowercase and separated by dashes (if needed).

* Brackets can be used to group subsets of files within the dataset.

* Single-file datasets can use the ``url`` field.

* If dataset comes from a dataset repository or single entity, a short prefix

  should be added to the name (i.e.: ``fte-`` for FiveThirty datasets).

* If a dataset has a download page but is not available for direct downloading,

  the field `restricted` must be set to `true`.

Example recipes:

* Single-file: `fte-pulitzer.yaml `_

* Multiple-files: `uci-zoo.yaml `_

* Multiple-files with subsets: `fte-uber-tlc.yaml `_

* Multiple-files with subsets and dates: `nyc-tlc-taxi.yaml `_

* Restricted downloads: `kaggle-comp-titanic.yaml `_