Rath
Tools
TypeScript
RATH
Next Generation Open Source Augmented Analytics BI
<p>
</a><br /> <a rel="nofollow noopener" target="_blank" href="https://medium.com/@kanaries_data"></p>
<p>
</a><br /> <a rel="nofollow noopener" target="_blank" href="https://discord.gg/Z4ngFWXz2U"></p>
<p>
</a><br /> <a rel="nofollow noopener" target="_blank" href="https://join.slack.com/t/kanaries/shared_invite/zt-1k60sgaxu-aGcuS7CwGeJUccE61iGopg"></p>
<p>
</a>
</p>
<p>
<a rel="nofollow noopener" target="_blank" href="https://www.gnu.org/licenses/agpl-3.0.en.html"></p>
<p>
</a>
</p>
<h2 dir="auto">
<a rel="nofollow noopener" target="_blank" id="user-content-introduction" class="anchor" aria-hidden="true" href="#introduction"></a>Introduction
</h2>
<p>
<strong>RATH</strong> is beyond an open-source alternative to Data Analysis and Visualization tools such as Tableau. It automates your Exploratory Data Analysis workflow with an Augmented Analytic engine by discovering patterns, insights, causals and presents those insights with powerful auto-generated multi-dimensional data visualization.<br /> <a rel="nofollow noopener" target="_blank" href="https://kanaries.net"></a>
</p>
<h2 dir="auto">
<a rel="nofollow noopener" target="_blank" id="user-content-get-started" class="anchor" aria-hidden="true" href="#get-started"></a>Get started
</h2>
<p>
To get started with RATH, you can:
</p>
<ul dir="auto">
<li>
🚀 <a rel="nofollow noopener" target="_blank" href="https://rath.kanaries.net">Try RATH now!</a>
</li>
<li>
📖 <a rel="nofollow noopener" target="_blank" href="https://docs.kanaries.net">Read RATH Docs</a>
</li>
<li>
<a rel="nofollow noopener" target="_blank" href="https://youtu.be/djqePNyhz7w">Video introducing RATH’s data painter</a>
</li>
</ul>
<p>
<strong>RATH</strong> is an ongoing project, actively being developed and maintained by a group of data scientists, developers and community enthusiasts. We are a group of people who are passionate about creating the next generation of data analytic tools.<br /> 💪Join us, let’s build it up!💪<br /> <a rel="nofollow noopener" target="_blank" href="https://join.slack.com/t/kanaries/shared_invite/zt-1k60sgaxu-aGcuS7CwGeJUccE61iGopg"></a><br /> <a rel="nofollow noopener" target="_blank" href="https://discord.gg/Z4ngFWXz2U"> </a>
</p>
<blockquote>
<p>
Please consider sharing your experience or thoughts about <a rel="nofollow noopener" target="_blank" href="https://kanaries.net">Kanaries RATH</a> with the border Open Source community. It really does help!
</p>
</blockquote>
<p>
<a rel="nofollow noopener" target="_blank" href="https://twitter.com/share?url=https://github.com/Kanaries/Rath&text=OpenSource%20Augmented%20Analytic%20BI%20Solution:%20Automated%20Exploratory%20Data%20Analysis%20for%20Data%20Science"></a>
</p>
<h2 dir="auto">
<a rel="nofollow noopener" target="_blank" id="user-content-table-of-contents" class="anchor" aria-hidden="true" href="#table-of-contents"></a>Table of contents
</h2>
<p>
| <a rel="nofollow noopener" target="_blank" href="#why-use-rath">Why use RATH?</a> | <a rel="nofollow noopener" target="_blank" href="#try-rath">Try RATH</a> | <a rel="nofollow noopener" target="_blank" href="#feature-highlights">Feature highlights</a> | <a rel="nofollow noopener" target="_blank" href="#walkthroughs">Walkthroughs</a> | <a rel="nofollow noopener" target="_blank" href="#developer-documentation">Developer Documentation</a> | <a rel="nofollow noopener" target="_blank" href="#project-status">Project Status</a> | <a rel="nofollow noopener" target="_blank" href="#community">Community</a> | <a rel="nofollow noopener" target="_blank" href="#contributions">Contributions</a> | <a rel="nofollow noopener" target="_blank" href="#license-agpl">License (AGPL)</a> |
</p>
<h2 dir="auto">
<a rel="nofollow noopener" target="_blank" id="user-content-why-use-rath" class="anchor" aria-hidden="true" href="#why-use-rath"></a>Why use RATH?
</h2>
<ul dir="auto">
<li>
Effortlessly automate your Exploratory Data Analysis process.
</li>
<li>
Generate editable and insightful data visualizations. Freely modify your visualizations with Vega/Vega-lite.
</li>
<li>
Support a variety of database types.
</li>
<li>
Use predictive interaction to provide analysis suggestions based on your operation and status.
</li>
<li>
Paint your data to explore your datasets directly with Data Painter.
</li>
<li>
Causal discovery and explainer module to help you understand complex data patterns.
</li>
</ul>
<h2 dir="auto">
<a rel="nofollow noopener" target="_blank" id="user-content-try-rath" class="anchor" aria-hidden="true" href="#try-rath"></a>Try RATH
</h2>
<p>
You can either:
</p>
<ul dir="auto">
<li>
Run RATH in a browser. <a rel="nofollow noopener" target="_blank" href="https://rath.kanaries.net/">RATH Cloud</a>
</li>
<li>
Download the <a rel="nofollow noopener" target="_blank" href="https://kanaries.net/#/products">desktop version</a> for Windows/Mac.
</li>
<li>
Run your own RATH instance. Steps:
</li>
</ul>
<pre>git clone https://github.com/Kanaries/Rath.git && cd Rath
Clone the Rath repository>
Clone the Rath repository #
yarn install
Setup your Yarn workspace>
Setup your Yarn workspace #
yarn workspace rath-client start
Boot up RATH>
Boot up RATH #
<h2 dir="auto">
<a rel="nofollow noopener" target="_blank" id="user-content-feature-highlights" class="anchor" aria-hidden="true" href="#feature-highlights"></a>Feature highlights
</h2>
<ul dir="auto">
<li>
👓 <a rel="nofollow noopener" target="_blank" href="https://docs.kanaries.net/data-source">Data profiling</a>: overview your data source with one click. You can upload, sample, define dimensions and measures, perform data cleaning and more complicated computing on your data source.
</li>
<li>
🤖 <a rel="nofollow noopener" target="_blank" href="https://docs.kanaries.net/auto-explore">Mega-auto exploration</a>: a fully-automated way to explore your data set and visualize your data with one click. Leave everything to RATH, simply pick the associate view that inspires you the most.
</li>
<li>
🛠 <a rel="nofollow noopener" target="_blank" href="https://docs.kanaries.net/semi-auto-explore">Semi-auto exploration</a>: The middle ground between a fully automated Data Exploration and manual exploration. RATH will work as your copilot, learn your interests and uses augmented analytics engine to generate relevant recommendations for you.
</li>
<li>
🎨 <a rel="nofollow noopener" target="_blank" href="https://docs.kanaries.net/data-painter">Data painter</a>: An interactive, instinctive yet powerful tool for exploratory data analysis by directly coloring your data, with further analytical features. A video about data painter <a rel="nofollow noopener" target="_blank" href="https://youtu.be/djqePNyhz7w">here</a>
</li>
<li>
📊 Dashboard: build a beautiful interactive data dashboard.
</li>
<li>
🚧 Causal Analysis: Provide causal discovery and explanations for complex relation analysis.
</li>
<li>
🎓 Wanna learn more about RATH? Visit our <a rel="nofollow noopener" target="_blank" href="https://docs.kanaries.net/tutorials">Free online Courses</a>: Access learning materials, detailed instructions and skill tests for <strong>FREE</strong>!
</li>
</ul>
<h2 dir="auto">
<a rel="nofollow noopener" target="_blank" id="user-content-walkthroughs" class="anchor" aria-hidden="true" href="#walkthroughs"></a>Walkthroughs
</h2>
<h3 dir="auto">
<a rel="nofollow noopener" target="_blank" id="user-content-import-data-from-online-databases-or-csvjson-files" class="anchor" aria-hidden="true" href="#import-data-from-online-databases-or-csvjson-files"></a>Import data from online databases or CSV/JSON files.
</h3>
<p>
<a rel="nofollow noopener" target="_blank" href="https://docs.kanaries.net/data-profiling#import-your-data"></a>
</p>
<h3 dir="auto">
<a rel="nofollow noopener" target="_blank" id="user-content-view-statistics-from-your-data-source" class="anchor" aria-hidden="true" href="#view-statistics-from-your-data-source"></a>View statistics from your data source
</h3>
<p>
<a rel="nofollow noopener" target="_blank" href="https://docs.kanaries.net/data-profiling#data-profiling"></a>
</p>
<h3 dir="auto">
<a rel="nofollow noopener" target="_blank" id="user-content-one-click-automated-data-analysis-with-visualizations" class="anchor" aria-hidden="true" href="#one-click-automated-data-analysis-with-visualizations"></a>One-click automated data analysis with visualizations
</h3>
<p>
<a rel="nofollow noopener" target="_blank" href="https://docs.kanaries.net/mega-auto-data-exploration"></a>
</p>
<h3 dir="auto">
<a rel="nofollow noopener" target="_blank" id="user-content-use-rath-as-your-ai-copilot-in-data-analysis" class="anchor" aria-hidden="true" href="#use-rath-as-your-ai-copilot-in-data-analysis"></a>Use RATH as your AI Copilot in Data Analysis
</h3>
<p>
Assisted with AI, RATH can help you with your data analysis. Just provide RATH with some input and it will learn about your interests and suggest analysis directions to take.<br /> <a rel="nofollow noopener" target="_blank" href="https://docs.kanaries.net/semi-auto-data-exploration"></a>
</p>
<h3 dir="auto">
<a rel="nofollow noopener" target="_blank" id="user-content-manually-explore-your-data-with-drag-and-drop" class="anchor" aria-hidden="true" href="#manually-explore-your-data-with-drag-and-drop"></a>Manually explore your data with drag and drop:
</h3>
<p>
<a rel="nofollow noopener" target="_blank" href="https://docs.kanaries.net/semi-auto-data-exploration#manually-explore-your-data"></a>
</p>
<blockquote>
<p>
Manual Exploration is an independent embedding module. You can use it independently in your apps. For more details, refer to the README.md in in <code>packages/graphic-walker/README.md</code>.<br /> Install Graphic Walker
</p>
<pre>yarn add @kanaries/graphic-walker
or>
or #
npm i –save @kanaries/graphic-walker
<h3 dir="auto">
<a rel="nofollow noopener" target="_blank" id="user-content-sparkles-interactive-data-analysis-workflow-by-data-painting" class="anchor" aria-hidden="true" href="#sparkles-interactive-data-analysis-workflow-by-data-painting"></a>✨ Interactive data analysis workflow by data painting
</h3>
<p>
<a rel="nofollow noopener" target="_blank" href="https://youtu.be/djqePNyhz7w">Data Painter Video 🔥 on Youtube</a><br /> <a rel="nofollow noopener" target="_blank" href="https://docs.kanaries.net/data-painter"></a>
</p>
<h3 dir="auto">
<a rel="nofollow noopener" target="_blank" id="user-content--causal-analysis-alpha-stage" class="anchor" aria-hidden="true" href="#-causal-analysis-alpha-stage"></a>🌅 Causal Analysis (Alpha stage)
</h3>
<p>
Causal analysis could be defined as the way to identify and examine the causal relationship between variables, which can help explore the data, create better prediction models and make business decission.<br /> RATH’s causal analysis feature include:
</p>
<ul dir="auto">
<li>
Causal Discovery
</li>
<li>
Editable graphical causal models
</li>
<li>
Causal interpretability
</li>
<li>
Interactive tools for deeper exploration
</li>
<li>
What-if analysis
</li>
</ul>
<p>
<a rel="nofollow noopener" target="_blank" href="https://camo.githubusercontent.com/bce2ca68a7b3b23d4cc36a4e955c5667688e844a64c2db85989d223b526cd2ec/68747470733a2f2f6b616e61726965732d646f63732e6f73732d636e2d68616e677a686f752e616c6979756e63732e636f6d2f696d672f6769746875622d726561646d652f63617573616c2d616e616c797369732e706e67"></a><br /> For more about Causal Analysis features, refer to <a rel="nofollow noopener" target="_blank" href="https://docs.kanaries.net/causal-analysis">RATH Docs</a>.
</p>
<h2 dir="auto">
<a rel="nofollow noopener" target="_blank" id="user-content-supported-databases" class="anchor" aria-hidden="true" href="#supported-databases"></a>Supported Databases
</h2>
<p>
RATH supports a wide range of data sources. Here are some of the major database solutions that you can connect to RATH:
</p>
<p>
<a rel="nofollow noopener" target="_blank" href="https://camo.githubusercontent.com/b3b66ccf8fc28178eaf07a709a7a0137e1ec25f396d3c23c08a5b8e1057b7f6f/68747470733a2f2f6b616e61726965732d646f63732e6f73732d636e2d68616e677a686f752e616c6979756e63732e636f6d2f696d672f6769746875622d6c6f676f732f617468656e612e706e67"></a><br /> <a rel="nofollow noopener" target="_blank" href="https://camo.githubusercontent.com/a0196670e241fde6392280d2dcbbd77a07c86985a2fb085a825a5095154f2c10/68747470733a2f2f6b616e61726965732d646f63732e6f73732d636e2d68616e677a686f752e616c6979756e63732e636f6d2f696d672f6769746875622d6c6f676f732f72656473686966742e706e67"></a><br /> <a rel="nofollow noopener" target="_blank" href="https://camo.githubusercontent.com/5987287d0493ead71b7d245ca4fe4510ebc82b84da08bf63064784f1af2fe5be/68747470733a2f2f6b616e61726965732d646f63732e6f73732d636e2d68616e677a686f752e616c6979756e63732e636f6d2f696d672f6769746875622d6c6f676f732f737061726b2e706e67"></a><br /> <a rel="nofollow noopener" target="_blank" href="https://camo.githubusercontent.com/c1ae2c2744c0f24a980b3f521441e3bbdbd170bfcbb0a223ba11e14c2c2c4b81/68747470733a2f2f6b616e61726965732d646f63732e6f73732d636e2d68616e677a686f752e616c6979756e63732e636f6d2f696d672f6769746875622d6c6f676f732f646f7269732e706e67"></a><br /> <a rel="nofollow noopener" target="_blank" href="https://camo.githubusercontent.com/b5b90be672f5cff34c1b11c1d2837f7ce267b8007e75c91d7c8e62ac96b055e6/68747470733a2f2f6b616e61726965732d646f63732e6f73732d636e2d68616e677a686f752e616c6979756e63732e636f6d2f696d672f6769746875622d6c6f676f732f636c69636b686f7573652e706e67"></a><br /> <a rel="nofollow noopener" target="_blank" href="https://camo.githubusercontent.com/819aa5d0e067d89d8a39f66d5f6fdd4a87be5f9d0e0fd8741c4be2c10f95fec2/68747470733a2f2f6b616e61726965732d646f63732e6f73732d636e2d68616e677a686f752e616c6979756e63732e636f6d2f696d672f6769746875622d6c6f676f732f686976652e706e67"></a><br /> <a rel="nofollow noopener" target="_blank" href="https://camo.githubusercontent.com/42fbd71f67c59547d7eeec7274ef38a08f47c8b64253feeb893246bdd7c7dbbd/68747470733a2f2f6b616e61726965732d646f63732e6f73732d636e2d68616e677a686f752e616c6979756e63732e636f6d2f696d672f6769746875622d6c6f676f732f6d7973716c2e706e67"></a><br /> <a rel="nofollow noopener" target="_blank" href="https://camo.githubusercontent.com/774533861ffc049f83dce2ed95651eb0a595180ca1ff7c52f9aa9e9217d832d7/68747470733a2f2f6b616e61726965732d646f63732e6f73732d636e2d68616e677a686f752e616c6979756e63732e636f6d2f696d672f6769746875622d6c6f676f732f706f737467726573716c2e706e67"></a><br /> <a rel="nofollow noopener" target="_blank" href="https://camo.githubusercontent.com/be927147d589070f2efad0f8dde86562911793589e796024d0e0195bdb01e8e4/68747470733a2f2f6b616e61726965732d646f63732e6f73732d636e2d68616e677a686f752e616c6979756e63732e636f6d2f696d672f6769746875622d6c6f676f732f696d70616c612e706e67"></a><br /> <a rel="nofollow noopener" target="_blank" href="https://camo.githubusercontent.com/ec006d611a863040bc5f7a7c7cc05e17679ead496d15ea5e52225177273dcd76/68747470733a2f2f6b616e61726965732d646f63732e6f73732d636e2d68616e677a686f752e616c6979756e63732e636f6d2f696d672f6769746875622d6c6f676f732f6b796c696e2e706e67"></a><br /> <a rel="nofollow noopener" target="_blank" href="https://camo.githubusercontent.com/af305f92461870b5f625679e3e81c77ca0c18fc1e47c1e90555a0dcd2c97a626/68747470733a2f2f6b616e61726965732d646f63732e6f73732d636e2d68616e677a686f752e616c6979756e63732e636f6d2f696d672f6769746875622d6c6f676f732f6f7261636c652e706e67"></a><br /> <a rel="nofollow noopener" target="_blank" href="https://camo.githubusercontent.com/eaf9010bb4a30fcd21d716cedb0bbb875acd6bfa92f8caa9e0eb6790a8fd930e/68747470733a2f2f6b616e61726965732d646f63732e6f73732d636e2d68616e677a686f752e616c6979756e63732e636f6d2f696d672f6769746875622d6c6f676f732f6169727461626c652e706e67"></a>
</p>
<p>
If you want to add support for more database types or data engines, feel free to <a rel="nofollow noopener" target="_blank" href="https://docs.kanaries.net/join#-need-help">Contact us</a>
</p>
<h2 dir="auto">
<a rel="nofollow noopener" target="_blank" id="user-content-developer-documentation" class="anchor" aria-hidden="true" href="#developer-documentation"></a>Developer Documentation
</h2>
<p>
We encourage you to check out our <a rel="nofollow noopener" target="_blank" href="https://docs.kanaries.net">RATH Docs</a> for references and guidance. RATH Docs are scripted and maintained by technical writers and editors who collectively follow a standardized <a rel="nofollow noopener" target="_blank" href="https://docs.kanaries.net/documentation-style-guide">style guide</a> to produce clear and consistent documentation.
</p>
<h2 dir="auto">
<a rel="nofollow noopener" target="_blank" id="user-content-project-status" class="anchor" aria-hidden="true" href="#project-status"></a>Project Status
</h2>
<p>
<a rel="nofollow noopener" target="_blank" href="https://camo.githubusercontent.com/e9c4a2a435447f009da25cfe8919cbc47efab23c3e0e80bd37bac98146263ce9/68747470733a2f2f7265706f62656174732e6178696f6d2e636f2f6170692f656d6265642f306161306466303036656136383537633032353635303433643339633262306461353338306639332e737667"></a>
</p>
<h2 dir="auto">
<a rel="nofollow noopener" target="_blank" id="user-content-community" class="anchor" aria-hidden="true" href="#community"></a>Community
</h2>
<p>
<a rel="nofollow noopener" target="_blank" href="https://docs.kanaries.net/community">Kanaries community</a> is a place to have open discussions on features, voice your ideas, or get help with general questions. Get onboard with us through the following channels:<br /> Our developer community is the backbone of the ongoing RATH project. We sincerely welcome you to join our community, participate in the conversation and stay connected with us for the latest updates.
</p>
<ul dir="auto">
<li>
<a rel="nofollow noopener" target="_blank" href="https://join.slack.com/t/kanaries/shared_invite/zt-1k60sgaxu-aGcuS7CwGeJUccE61iGopg">Join our Slack</a>
</li>
<li>
<a rel="nofollow noopener" target="_blank" href="https://discord.gg/Z4ngFWXz2U">Join our Discord</a>
</li>
</ul>
<p>
Feel free to contribute to the RATH project, submit any issues on our GitHub page, or split your grand new ideas in our chats.
</p>
<h2 dir="auto">
<a rel="nofollow noopener" target="_blank" id="user-content-contributions" class="anchor" aria-hidden="true" href="#contributions"></a>Contributions
</h2>
<p>
Please check out the <a rel="nofollow noopener" target="_blank" href="https://docs.kanaries.net/contribution-guide">Contributing to RATH guide</a><br /> for guidelines about how to proceed.<br /> Thanks to all contributors ❤️
</p>
<h2 dir="auto">
<a rel="nofollow noopener" target="_blank" id="user-content-license-agpl" class="anchor" aria-hidden="true" href="#license-agpl"></a>LICENSE (AGPL)
</h2>
<p>
Rath is an automated data analysis and visualization tool (auto-EDA).<br /> This program is free software: you can redistribute it and/or modify<br /> it under the terms of the GNU Affero General Public License as<br /> published by the Free Software Foundation, either version 3 of the<br /> License, or (at your option) any later version.<br /> This program is distributed in the hope that it will be useful,<br /> but WITHOUT ANY WARRANTY; without even the implied warranty of<br /> MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the<br /> GNU Affero General Public License for more details.<br /> You should have received a copy of the GNU Affero General Public License<br /> along with this program. If not, see <a rel="nofollow noopener" target="_blank" href="https://www.gnu.org/licenses/">https://www.gnu.org/licenses/</a>.
</p>
<p>
Branded icons are licensed under their copyright license.
</p>
<p>
<strong>Have fun with data!</strong> ❤️
</p>
<p>
<a rel="nofollow noopener" target="_blank" href="#welcome">⬆ Back to Top</a><br />
</p>