Skip to content

Map Docs #70

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 4 commits into
base: main
Choose a base branch
from
Draft

Map Docs #70

wants to merge 4 commits into from

Conversation

jesi-rgb
Copy link

@jesi-rgb jesi-rgb commented May 28, 2025

fixes #10

Copy link

netlify bot commented May 28, 2025

Deploy Preview for svelteplot ready!

Name Link
🔨 Latest commit fe40eb3
🔍 Latest deploy log https://app.netlify.com/projects/svelteplot/deploys/6838bc3b94146900086282c4
😎 Deploy Preview https://deploy-preview-70--svelteplot.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@jesi-rgb jesi-rgb changed the title first attempt at map docs Map Docs May 28, 2025
@jesi-rgb jesi-rgb marked this pull request as draft May 28, 2025 10:08
@jesi-rgb jesi-rgb marked this pull request as ready for review May 28, 2025 10:08
@jesi-rgb jesi-rgb marked this pull request as draft May 28, 2025 14:25
@Wolfr
Copy link
Contributor

Wolfr commented May 28, 2025

Awesome.

@jesi-rgb
Copy link
Author

As I'm writing this section, @gka, I find it weird that the current available transforms are inside a "Map" category. As per d3-array's documentation, this lies under "Summarizing Data".

I would expect a Map transformer to receive a callback function that transforms the data in some way. For example, taking all Athlete names and converting them to a smaller format:

"Michael Phelps" → "M. Phelps"
"Aaron Brown" → "A. Brown"

This is a small example but I think it gets the point across of what I'm trying to say.

Maybe the current "Map" section could be called "Summarize", a series of transformations to summarize the data, in which we can now include the rest of the available methods, like sum, min, max, and so on.

Maybe I'm understanding it wrong, though! Would love if you could shed some light on this topic!

@jamesscottbrown
Copy link
Contributor

Maybe the current "Map" section could be called "Summarize", a series of transformations to summarize the data, in which we can now include the rest of the available methods, like sum, min, max, and so on.

I'd expect a map function to transform a list of values to a list of the same length, but containing modified values.

I'd expect a summarize function to transform a list of values to a single value.

Cumsum, rank and quantile transform a list of values to another list of values, so I think they're more appropriately described as map than summarize.

However, I would generally expect a map function to act on each value individually. There might be an alternative name that is clearer, but Map is what Observable Plot uses and it woud be good to maintain API compatability.

@jesi-rgb
Copy link
Author

However, I would generally expect a map function to act on each value individually. There might be an alternative name that is clearer, but Map is what Observable Plot uses and it woud be good to maintain API compatability.

I guess this is the core issue: it's a cumsum is a Map because it receives an array and outputs an array of the same size, but output is dependent on all elements

GlobalMap, or something along those lines could work. I do agree, though, to stick to Observable's API naming. In fact, I was trying to stick with d3's!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

docs: Map transform docs need some 💙
3 participants