feature: add jitterX and jitterY transforms #65
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✅ Deploy Preview for svelteplot ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
There was a problem hiding this comment.
Pull Request Overview
This pull request adds new jitter transforms (jitterX and jitterY) to SveltePlot to reduce overplotting, along with documentation improvements, updated type annotations, and helper function updates for time and date handling. Key changes include:
- Implementation of the jitter transform using both uniform and normal distributions.
- Creation of new documentation pages and sidebar entries for the jitter transform.
- Updates to type checking and time helper functions for better type safety.
Reviewed Changes
Copilot reviewed 11 out of 11 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| src/routes/transforms/jitter/+page.ts | Adds a loader to fetch example datasets for the jitter page. |
| src/routes/transforms/jitter/+page.md | New documentation explaining jitter transform usage. |
| src/routes/transforms/interval/+page.md | Minor update: removal of an unused import. |
| src/routes/transforms/bolliner/+page.md | Added a placeholder page for the Bollinger transform. |
| src/routes/features/transforms/+page.md | Updates the list of available transforms to include jitter. |
| src/lib/transforms/jitter.ts | Implements jitterX and jitterY transforms with random noise. |
| src/lib/transforms/jitter.test.ts | Adds tests for jitter transform functionality. |
| src/lib/transforms/index.ts | Exports the new jitter transforms for external use. |
| src/lib/helpers/typeChecks.ts | Updates the isDate function to use a TypeScript type guard. |
| src/lib/helpers/time.ts | Updates type annotations and exports durations and interval functions. |
| config/sidebar.ts | Adds a sidebar entry for the jitter transform. |
Comments suppressed due to low confidence (1)
src/lib/transforms/jitter.test.ts:101
- [nitpick] The jitterY test uses a channel key 'y' with a value 'x', which may be confusing. Consider using a consistent naming convention (e.g., { data, y: 'y' }) to clarify that the jitter is applied to the y-axis.
const result = jitterY({ data, y: 'x' }, { source: mockRandom });
|
📦 Preview package for this PR is published! Version: Install it with: npm install svelteplot@pr-65
# or install the specific version
npm install svelteplot@0.2.7-pr-65.2 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
demo
This pull request introduces a new jitter transform to SveltePlot, along with related updates to documentation, type definitions, and helper functions.
The jitter transform adds random noise in data space, which is useful for reducing overplotting in visualizations. Additionally, various type annotations and exports have been updated for improved code clarity and maintainability.
New
jitterTransform:jitterXandjitterYfunctions to implement thejittertransform, which supports both uniform and normal distributions. These functions include options for width, standard deviation, and handling temporal data (src/lib/transforms/jitter.ts).jitterXandjitterYfromsrc/lib/transforms/index.tsfor external use.jittertransform inconfig/sidebar.ts.Documentation Updates:
jittertransform, explaining its usage, options, and examples for numeric and temporal data (src/routes/transforms/jitter/+page.md).jitterpage to fetch example datasets (src/routes/transforms/jitter/+page.ts).jitter(src/routes/features/transforms/+page.md).Type Annotations and Helper Updates:
src/lib/helpers/time.ts, includingparseTimeInterval,maybeTimeInterval, andasInterval. These updates improve type safety and clarity. [1] [2] [3]isDatefunction insrc/lib/helpers/typeChecks.tsto use a TypeScript type guard, improving type inference.Open issues