/calipr-utils

A utility collection, consisting of R plotting/data manipulation code, Python snippets, libraries and plot themes, useful LaTeX commands, obtainable datasets, and various programs used in research.

Primary LanguageRMIT LicenseMIT

calipr-utils

A utility collection, consisting of R plotting code, libraries and themes, useful LaTeX commands, obtainable datasets, and various programs used in research.

Please see the Wiki for further documentation.

Upcoming Changes

  • Add installation section to readme
  • Add acknowledgements to readme
  • Global specifications for file names and formats, make contributions easier
  • R theme code for lab
  • R plotting code templates
  • Various R tricks
  • R package installation script
  • Python useful library installation script
  • Create either Python scripts collection, or Python package with collection of scripts
  • Custom LaTeX command file
  • Base dataset obtain script, to be extended for more datasets (scrapers)
  • Write API for obtaining datasets (historical/current, ex. which ASN for given IP in given year)
  • Create list of useful libraries

Getting Started

Clone the repository, which by default will have available R code and LaTeX code. There will be some scripts you can run to obtain datasets as well, and installation scrips for useful R and Python packages.

Prerequisites

Python 3 (and pip), LaTeX, and R.

Installing

git clone https://github.com/adunna/calipr-utils.git

To install various pip packages (Python 3, assuming pip3 is installed), use the included pip-packages.sh script with root privileges, as sudo ./pip-packages.sh.

Contributing

If you have something useful to add to the repository, please contact @adunna or submit a PR. Formats are given along with examples for each type of contribution. Easy contributions are:

  • Py-Snips: Python code snippets.
  • R-Snips: R code snippets.
  • R-Themes: R plotting themes.
  • R-Packages: Useful R packages.

If you have any Python packages you'd like to add, or any useful libraries/resources such as citation managers, please contact @adunna.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Acknowledgments

  • ColorBrewer (Cynthia Brewer and Mark Harrower) for friendly color palettes.