README.md

In addiversitas/correally: Visualizing correlations

correally 0.1.0

Table of Contents

• About the Project
• Getting Started
• Prerequisites
• Installation
• Usage
• Roadmap
• Contributing
• License
• Contact

About The Project

correally is an R package providing methods to create interactive visualizations of correlation matrices. It is built as a wrapper around plotly.

It provides a clean implementation for plotting correlation matrices, easy use of different color schemes (Base R colors, Hex colors, colorbrewer2.org palettes as well as support for viridisLite). It also provides coloring options for backgrounds, grids and fonts matching different shinythemes.

Getting Started

To use correally, follow the steps listed below.

Prerequisites

• R (>= 3.3.0)

• Required packages are plotly, magrittr, reshape2, RColorBrewer and viridisLite and are installed automatically.

Installation

1. Install package

devtools::install_github("https://github.com/addiversitas/correally")

1. Load package in R

library(correally)

Usage

TODO

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the GPL-3 License.

Contact

Stefan Haring - [e-mail]

addiversitas/correally documentation built on Oct. 4, 2020, 12:14 a.m.