Skip to content

Script for downloading, unpacking, and converting public and open data into your preferred local format

License

Notifications You must be signed in to change notification settings

jimthedev/miner

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

36 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

miner

Build Status

Script for downloading, unpacking, and converting online and public (and others to be added soon) datafiles to open format

The goal of this app is to develop a bash interface, modeled after homebrew that will allow anyone free and open access to data that is available on the web. The hope is to make it possible to do three things easily:

  1. Search sources of data available online
  2. Make data easy to download and enter into a database (of your choice) into a common format
  3. Liberate public data by making it open data on your computer (you can use it in any format rather than proprietary formats, e.g. the US Census, which uses Access)

installation

If you have nodejs installed

`$npm install -g miner

If you have pip installed

$pip install miner

If you have R installed

$r install.packages("miner")

On Mac OS X $sudo pip install miner

If you have brew installed

$brew install miner

usage

Searching

$miner search (or dig) [dataset name] [OPTIONAL: subset name]

Example

$miner search (or dig) uscensus2010 $miner search (or dig) minnesotapublicschools

Describing (a dataset)

$miner describe (or assay) [dataset name] [OPTIONAL: subset name]

Example

$miner describe (or assay) uscensus2010 $miner describe (or assay) uscensus2010 nd

Installing

#miner install (or extract) [dataset name] [OPTIONAL: subset name]

Example

$miner install (or extract) uscensus2010 $miner install (or extract) uscensus2010 mn

miner & dat

What is the difference between miner and dat? We don't see ourselves as competitors. Rather, we are working on parallel and complementary projects. Here are what we see as differences:

  • miner focuses on using a formula (map) to get raw data files straight from original sources, download, and process them. dat is focused on building collaborative and version controlled datasets.
  • While miner is in early development, it will be fully operational quickly and aims to be a very small application. dat is still in early development and aims to be a much more robust and comprehensive data collaboration tool.
  • Cleaned data (as dat would allow the sharing of) is great for software projects! However, researchers often need raw datasets to choose cleaning methods and ensure quality.
  • Some data is public but not yet copyleft/open--downloading your own copy is the only legal way to use it. Shared repositories may be allowed privately, but would be difficult to get permission for publicly.
  • miner makes it possible to pull raw data regularly and note when data is changed (sometimes for good and perhaps sometimes for less good reasons.
  • miner might be used as one tool to easily dump into dat.

One way to look at it is that miner exists given today's non-standards-based, mixed license, individually/organizationally hosted dataset world. dat could be seen as the forerunner of the open knowledge / open data world.

About

Script for downloading, unpacking, and converting public and open data into your preferred local format

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published