Getting Started

Install from npm:

npm install @tidyjs/tidy
# or
yarn add @tidyjs/tidy

You can import individual functions from tidy:

import { tidy, mutate, arrange, desc } from '@tidyjs/tidy'

Note if you're just trying tidy in a browser, you can use the UMD version hosted on unpkg (codesandbox example):

<script src="https://d3js.org/d3-array.v2.min.js"></script>
<script src="https://www.unpkg.com/@tidyjs/tidy/dist/umd/tidy.min.js"></script>
<script>
  const { tidy, mutate, arrange, desc } = Tidy;
  // ...
</script>  

Then use them on an array of objects:

const data = [
  { a: 1, b: 10 }, 
  { a: 3, b: 12 }, 
  { a: 2, b: 10 }
]

const results = tidy(
  data, 
  mutate({ ab: d => d.a * d.b }),
  arrange(desc('ab'))
)

This produces the following results:

[
  { "a": 3, "b": 12, "ab": 36 },
  { "a": 2, "b": 10, "ab": 20 },
  { "a": 1, "b": 10, "ab": 10 }
]

The real fun starts when you group the data and manipulate subgroups.

import { tidy, summarize, sum, groupBy } from '@tidyjs/tidy'

const data = [
  { key: 'group1', value: 10 }, 
  { key: 'group2', value: 9 }, 
  { key: 'group1', value: 7 }
]

const results = tidy(
  data,
  groupBy('key', [
    summarize({ total: sum('value') })
  ])
)

This produces the following results:

[
  { "key": "group1", "total": 17 },
  { "key": "group2", "total": 9 },
]