documentation icon indicating copy to clipboard operation
documentation copied to clipboard

New trace type docs: funnel and funnelarea

Open nicolaskruchten opened this issue 6 years ago • 10 comments

Let's do

  • [ ] Python first
  • [x] then JS
  • [ ] then R.

Examples should focus on sales. funnel is a species of bar and funnelarea is a species of pie basically :)

nicolaskruchten avatar May 18 '19 02:05 nicolaskruchten

@archmoj please provide links to codepens showing various things.

nicolaskruchten avatar May 18 '19 02:05 nicolaskruchten

An outline of what I'd see as this documentation page:

  • Explanation of what a funnel is, and the two ways we allow you to visualize them: length-encoded bars with funnel or area-encoded trapezoids with funnelarea
  • Explanation of how funnel lets you do "part of previous" and "part of whole" vis, but how funnelarea only lets you do "part of whole"
  • Explanation of how both let you do multi-funnel comparisons (i.e. Sales Funnels by Salesperson) with grouped funnels or scalegrouped funnelareas
  • The dataset here can be very simple: synthetic data for four sales funnel stages for two salespeople.

nicolaskruchten avatar May 21 '19 14:05 nicolaskruchten

This should replace our existing funnel docs! https://plot.ly/python/funnel-charts/

nicolaskruchten avatar May 21 '19 14:05 nicolaskruchten

So plotly.js 14.8 will come out about a week before plotly.py 3.10 which will have funnel support. So we can do JS first but ideally the Python would be done in time for the 3.10 release, using the new dev_build artifacts from CI, which work great.

Basically go to https://circleci.com/gh/plotly/plotly.py/tree/master, find the "dev_build" build,

image

copy this link:

image

then pip install <link> ... that'll get you a bleeding-edge plotly.py build based on a bleeding-edge plotly.js build. perfect for QA and doc-writing before the release :)

nicolaskruchten avatar May 23 '19 14:05 nicolaskruchten

Recording verbal conversation with @Mahdis-z ... I think the docs here should have the following 5 examples, minimally, in order to show the various things that can be done:

  • [ ] part-of-previous funnel
  • [ ] part-of-whole funnel
  • [ ] part-of-whole funnelarea
  • [ ] two-way stack'ed funnel
  • [ ] two-way scalegroup'ed funnelarea

cc @michaelbabyn

nicolaskruchten avatar Jun 26 '19 14:06 nicolaskruchten

reopening as @Mahdis-z still needs to complete the plotly.js and r doc pages

cldougl avatar Jun 26 '19 16:06 cldougl

Looks like these aren't supported in R quite yet AFAICT but yes let's do the JS docs please :)

nicolaskruchten avatar Jun 27 '19 02:06 nicolaskruchten

Recording verbal conversation with @Mahdis-z ... I think the docs here should have the following 5 examples, minimally, in order to show the various things that can be done:

  • [ ] part-of-previous funnel
  • [ ] part-of-whole funnel
  • [ ] part-of-whole funnelarea
  • [ ] two-way stack'ed funnel
  • [ ] two-way scalegroup'ed funnelarea

cc @michaelbabyn

@nicolaskruchten Do you men having multiple examples for each values of textinfo showing percent initial vs. percent previous?

Mahdis-z avatar Jun 27 '19 20:06 Mahdis-z

@nicolaskruchten Do you men having multiple examples for each values of textinfo showing percent initial vs. percent previous?

I mean that we should have some text explaining the differences between the two ways of conceiving of funnel charts (part of whole vs part of previous) and an example for each. For part-of-whole I recommend a made-up sales funnel dataset (with two salespeople, say) and for part-of-previous I recommend a made-up website funnel dataset.

nicolaskruchten avatar Jun 28 '19 01:06 nicolaskruchten