|
| 1 | +# Data Tools |
| 2 | + |
| 3 | +A collection of random tools for manipulating data, |
| 4 | +with the primary goal of producing hetnets. |
| 5 | + |
| 6 | +## Description |
| 7 | + |
| 8 | +### Overview |
| 9 | + |
| 10 | +This is a collection of functions and tools for manipulating data. |
| 11 | + |
| 12 | +### Motivation |
| 13 | + |
| 14 | +This project was built from common operations I run in python and pandas. As I started to notice I was reusing blocks of |
| 15 | +code throughout my various projects I decided to abstract them into functions, and packge them in a way they could be |
| 16 | +easily integrated into future projects. For a project that uses this |
| 17 | +toolset see [metapaths](https://github.com/mmayers12/metapaths/). |
| 18 | + |
| 19 | +### Features |
| 20 | + |
| 21 | +This repo contains tools for: |
| 22 | + |
| 23 | +- Downloading data |
| 24 | +- Reshaping Series and DataFrames |
| 25 | +- Managing Graphs as DataFrames (separate Nodes and Edges objects) |
| 26 | +- Some prebaked Seaborn plots with a particular style |
| 27 | +- Processing and plotting Machine Learning results |
| 28 | + |
| 29 | +### Re-use and contributions statement |
| 30 | + |
| 31 | +Feel free to reuse code as you see fit. If you would like to make changes to the code, feel free to |
| 32 | +build your own forked version. |
| 33 | + |
| 34 | + |
| 35 | +## Getting Started |
| 36 | + |
| 37 | +To install the latest version with pip use the following command: |
| 38 | + |
| 39 | + pip install git+https://github.com/mmayers12/data_tools |
| 40 | + |
| 41 | +### Requirements |
| 42 | + |
| 43 | +See setup.py for a list of requirements. |
| 44 | + |
| 45 | +## Usage |
| 46 | + |
| 47 | +### How to use |
| 48 | + |
| 49 | +To use functions in this library import them into your script. |
| 50 | + |
| 51 | +### Code examples |
| 52 | + |
| 53 | + from data_tools.graphs import combine_nodes_and_edges |
| 54 | + combo = combine_nodes_and_edges(nodes, edges) |
| 55 | + |
| 56 | +## Project Status |
| 57 | + |
| 58 | +### Current status / build / version |
| 59 | + |
| 60 | +Project is currently under heavy development. Methods and features are subject to change greatly on subsequent versions. |
| 61 | + |
| 62 | +Current version is 0.0.8. |
| 63 | + |
| 64 | +## Credits |
| 65 | + |
| 66 | +### Contact info |
| 67 | + |
| 68 | +For bug reports please email mmayers[at]scripps.edu or raise an issue on Github. |
| 69 | + |
0 commit comments