Skip to content

Commit

Permalink
docs(components): add section for scales and confidence intervals
Browse files Browse the repository at this point in the history
  • Loading branch information
JonasKellerer committed May 16, 2024
1 parent f004bb2 commit 4c554bc
Show file tree
Hide file tree
Showing 14 changed files with 28 additions and 2 deletions.
2 changes: 1 addition & 1 deletion components/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@
"lint:lit-analyzer": "lit-analyzer",
"generate-manifest": "npx custom-elements-manifest analyze --litelement --globs src/web-components/**",
"generate-manifest:watch": "npm run generate-manifest -- --watch",
"format": "prettier \"**/*.{cjs,html,js,json,md,ts,tsx}\" --write",
"format": "prettier \"**/*.{cjs,html,js,json,md,ts,tsx,mdx}\" --write",
"check-format": "prettier --check \"**/*.{ts,tsx,json,md,mdx,mjs,cjs}\"",
"check-types": "tsc --noEmit",
"check-dependencies": "depcheck",
Expand Down
2 changes: 1 addition & 1 deletion components/src/web-components/index.ts
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
export { App } from './app.js';
export * from './display';
export * from './visualization';
export * from './input';
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
import { Meta } from '@storybook/blocks';

<Meta title='Visualization/Data Visualization and Statistical Analysis' />

# Data Visualization and Statistical Analysis

## Scales

On most plots, users can select the y-axis scaling through a dropdown.
They can choose between linear, logarithmic and logistic scaling.
By default, it is set to a linear scale.

In general, for each scale the displayed height of a value is by calculated applying the corresponding scale function.

- Linear: `value`
- Logarithmic: `ln(value)`
- Logistic: `ln(value / (1 - value))`

## Confindence Intervals

On bar and line plots, users can choose to display confidence intervals.
For line plots, this is done by shading the area between the upper and lower bounds.
For bar plots, this is done by adding error bars to the top of each bar.

Currently, only one method is available for calculating the confidence intervals:
the [wilson score interval](https://en.wikipedia.org/wiki/Binomial_proportion_confidence_interval#Wilson_score_interval) with a confidence level of 95%.

0 comments on commit 4c554bc

Please sign in to comment.