Giter Club home page Giter Club logo

flyover's Introduction

Lifecycle: experimental Codecov test coverage

flyover

Painlessly generate high-level visual comparisons of distributions between groups or data sets.

Purpose

This package is for you if:

  • you are dealing with many variables whose distributions may differ in important ways among groups;
  • you have refactored a data process and want to ensure that the new data is acceptably similar to the old data;
  • you are pulling data on a regular schedule and need to monitor data drift;
  • you wish to examine data quality visually rather than relying on statistical tests and thresholds.

flyover provides utilities to quickly generate and organize plots of distributions split by a grouping variable.

Documentation

For detailed instructions, see the package website.

This package is largely powered by ggplot2 for building plots, and the awesome trelliscopejs by Ryan Hafen for providing a viewer to navigate them.

Install

devtools::install_github("ataustin/flyover")
library(flyover)

Note that the dependencies are large (especially trelliscopejs) and may take a long time to install.

Quickstart

A typical flyover workflow has the following steps:

  1. Combine different data sets into a single table.
  2. Apply a plotting function to the columns of the table.
  3. Build a display to navigate the plots.

If you are comparing distribtions of variables between an old data process and a new one, your workflow might look like this:

old_data <- read.csv("old-data.csv")
new_data <- read.csv("new-data.csv")

enlist_data(old_data, new_data, names = c("old data", "new data")) %>%
  build_plots(flyover_histogram) %>%
  build_display(display_name = "histograms", output_dir = "display-hist")

Get started with the articles in the documentation or jump right into the gallery of displays.

Tips

If you build a display from the console or as a batch job from an R script, you can point your browser directly at the output directory to render the display. You can also render the display inside an R Markdown document by making the call to build_display the last line of a code chunk (ensure the output directory specification is a relative file path, or you will get a knitting error).

Contributing and reporting problems

Please see contribute.md.

flyover's People

Contributors

ataustin avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar  avatar

flyover's Issues

change dots order in function arguments

In various functions, the argument order goes: required, optional, ...

This forces the user to name all optional arguments prior to passing into the dots.

Instead the order should be: required, ..., optional.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.