feat: Pivot table example generator

plugins/plotly-express/docs/example-data.md

@@ -0,0 +1,111 @@
+# Example data
+
+The Deephaven Express package includes several built-in, deterministically generated ticking datasets for testing and experimentation. These datasets initialize with a default number of rows and are designed to demonstrate a range of plot types and pivot table use cases.
+
+### `iris` dataset
+
+```python
+from deephaven.plot import express as dx
+
+iris = dx.data.iris()
+```
+
+```{eval-rst}
+.. dhautofunction:: deephaven.plot.express.data.iris
+```
+
+### `marketing` dataset
+
+```python
+from deephaven.plot import express as dx
+
+marketing = dx.data.marketing()
+```
+
+```{eval-rst}
+.. dhautofunction:: deephaven.plot.express.data.marketing
+```
+
+### `jobs` dataset
+
+```python
+from deephaven.plot import express as dx
+
+jobs = dx.data.jobs()
+```
+
+```{eval-rst}
+.. dhautofunction:: deephaven.plot.express.data.jobs
+```
+
+### `stocks` dataset
+
+```python
+from deephaven.plot import express as dx
+
+stocks = dx.data.stocks()
+```
+
+```{eval-rst}
+.. dhautofunction:: deephaven.plot.express.data.stocks
+```
+
+### `tips` dataset
+
+```python
+from deephaven.plot import express as dx
+
+tips = dx.data.tips()
+```
+
+```{eval-rst}
+.. dhautofunction:: deephaven.plot.express.data.tips
+```
+
+### `election` dataset
+
+```python
+from deephaven.plot import express as dx
+
+election = dx.data.election()
+```
+
+```{eval-rst}
+.. dhautofunction:: deephaven.plot.express.data.election
+```
+
+### `wind` dataset
+
+```python
+from deephaven.plot import express as dx
+
+wind = dx.data.wind()
+```
+
+```{eval-rst}
+.. dhautofunction:: deephaven.plot.express.data.wind
+```
+
+### `gapminder` dataset
+
+```python
+from deephaven.plot import express as dx
+
+gapminder = dx.data.gapminder()
+```
+
+```{eval-rst}
+.. dhautofunction:: deephaven.plot.express.data.gapminder
+```
+
+### `fish_market` dataset
+
+```python
+from deephaven.plot import express as dx
+
+fish_market = dx.data.fish_market()
+```
+
+```{eval-rst}
+.. dhautofunction:: deephaven.plot.express.data.fish_market
+```

plugins/plotly-express/docs/sidebar.json

@@ -156,6 +156,10 @@
       {
         "label": "Limitations",
         "path": "limitations.md"
+      },
+      {
+        "label": "Example Data",
+        "path": "example-data.md"
       }
     ]
   }

plugins/plotly-express/docs/snapshots/0d46a7160c26bac3d461055643be674b.json

@@ -0,0 +1 @@
+{"file":"example-data.md","objects":{"gapminder":{"type":"Table","data":{"columns":[{"name":"Country","type":"java.lang.String"},{"name":"Continent","type":"java.lang.String"},{"name":"Year","type":"long"},{"name":"Month","type":"long"},{"name":"LifeExp","type":"double"},{"name":"Pop","type":"long"},{"name":"GdpPerCap","type":"double"}],"rows":[[{"value":"Afghanistan"},{"value":"Asia"},{"value":"1,952"},{"value":"1"},{"value":"28.8010"},{"value":"8,425,333"},{"value":"779.4453"}],[{"value":"Albania"},{"value":"Europe"},{"value":"1,952"},{"value":"1"},{"value":"55.2300"},{"value":"1,282,697"},{"value":"1,601.0561"}],[{"value":"Algeria"},{"value":"Africa"},{"value":"1,952"},{"value":"1"},{"value":"43.0770"},{"value":"9,279,525"},{"value":"2,449.0082"}],[{"value":"Angola"},{"value":"Africa"},{"value":"1,952"},{"value":"1"},{"value":"30.0150"},{"value":"4,232,095"},{"value":"3,520.6103"}],[{"value":"Argentina"},{"value":"Americas"},{"value":"1,952"},{"value":"1"},{"value":"62.4850"},{"value":"17,876,956"},{"value":"5,911.3151"}],[{"value":"Australia"},{"value":"Oceania"},{"value":"1,952"},{"value":"1"},{"value":"69.1200"},{"value":"8,691,212"},{"value":"10,039.5956"}],[{"value":"Austria"},{"value":"Europe"},{"value":"1,952"},{"value":"1"},{"value":"66.8000"},{"value":"6,927,772"},{"value":"6,137.0765"}],[{"value":"Bahrain"},{"value":"Asia"},{"value":"1,952"},{"value":"1"},{"value":"50.9390"},{"value":"120,447"},{"value":"9,867.0848"}],[{"value":"Bangladesh"},{"value":"Asia"},{"value":"1,952"},{"value":"1"},{"value":"37.4840"},{"value":"46,886,859"},{"value":"684.2442"}],[{"value":"Belgium"},{"value":"Europe"},{"value":"1,952"},{"value":"1"},{"value":"68.0000"},{"value":"8,730,405"},{"value":"8,343.1051"}],[{"value":"Benin"},{"value":"Africa"},{"value":"1,952"},{"value":"1"},{"value":"38.2230"},{"value":"1,738,315"},{"value":"1,062.7522"}],[{"value":"Bolivia"},{"value":"Americas"},{"value":"1,952"},{"value":"1"},{"value":"40.4140"},{"value":"2,883,315"},{"value":"2,677.3263"}],[{"value":"Bosnia and Herzegovina"},{"value":"Europe"},{"value":"1,952"},{"value":"1"},{"value":"53.8200"},{"value":"2,791,000"},{"value":"973.5332"}],[{"value":"Botswana"},{"value":"Africa"},{"value":"1,952"},{"value":"1"},{"value":"47.6220"},{"value":"442,308"},{"value":"851.2411"}],[{"value":"Brazil"},{"value":"Americas"},{"value":"1,952"},{"value":"1"},{"value":"50.9170"},{"value":"56,602,560"},{"value":"2,108.9444"}],[{"value":"Bulgaria"},{"value":"Europe"},{"value":"1,952"},{"value":"1"},{"value":"59.6000"},{"value":"7,274,900"},{"value":"2,444.2866"}],[{"value":"Burkina Faso"},{"value":"Africa"},{"value":"1,952"},{"value":"1"},{"value":"31.9750"},{"value":"4,469,979"},{"value":"543.2552"}],[{"value":"Burundi"},{"value":"Africa"},{"value":"1,952"},{"value":"1"},{"value":"39.0310"},{"value":"2,445,618"},{"value":"339.2965"}],[{"value":"Cambodia"},{"value":"Asia"},{"value":"1,952"},{"value":"1"},{"value":"39.4170"},{"value":"4,693,836"},{"value":"368.4693"}],[{"value":"Cameroon"},{"value":"Africa"},{"value":"1,952"},{"value":"1"},{"value":"38.5230"},{"value":"5,009,067"},{"value":"1,172.6677"}],[{"value":"Canada"},{"value":"Americas"},{"value":"1,952"},{"value":"1"},{"value":"68.7500"},{"value":"14,785,584"},{"value":"11,367.1611"}],[{"value":"Central African Republic"},{"value":"Africa"},{"value":"1,952"},{"value":"1"},{"value":"35.4630"},{"value":"1,291,695"},{"value":"1,071.3107"}],[{"value":"Chad"},{"value":"Africa"},{"value":"1,952"},{"value":"1"},{"value":"38.0920"},{"value":"2,682,462"},{"value":"1,178.6659"}],[{"value":"Chile"},{"value":"Americas"},{"value":"1,952"},{"value":"1"},{"value":"54.7450"},{"value":"6,377,619"},{"value":"3,939.9788"}],[{"value":"China"},{"value":"Asia"},{"value":"1,952"},{"value":"1"},{"value":"44.0000"},{"value":"556,263,527"},{"value":"400.4486"}],[{"value":"Colombia"},{"value":"Americas"},{"value":"1,952"},{"value":"1"},{"value":"50.6430"},{"value":"12,350,771"},{"value":"2,144.1151"}],[{"value":"Comoros"},{"value":"Africa"},{"value":"1,952"},{"value":"1"},{"value":"40.7150"},{"value":"153,936"},{"value":"1,102.9909"}],[{"value":"Congo, Dem. Rep."},{"value":"Africa"},{"value":"1,952"},{"value":"1"},{"value":"39.1430"},{"value":"14,100,005"},{"value":"780.5423"}],[{"value":"Congo, Rep."},{"value":"Africa"},{"value":"1,952"},{"value":"1"},{"value":"42.1110"},{"value":"854,885"},{"value":"2,125.6214"}],[{"value":"Costa Rica"},{"value":"Americas"},{"value":"1,952"},{"value":"1"},{"value":"57.2060"},{"value":"926,317"},{"value":"2,627.0095"}],[{"value":"Cote d'Ivoire"},{"value":"Africa"},{"value":"1,952"},{"value":"1"},{"value":"40.4770"},{"value":"2,977,019"},{"value":"1,388.5947"}],[{"value":"Croatia"},{"value":"Europe"},{"value":"1,952"},{"value":"1"},{"value":"61.2100"},{"value":"3,882,229"},{"value":"3,119.2365"}],[{"value":"Cuba"},{"value":"Americas"},{"value":"1,952"},{"value":"1"},{"value":"59.4210"},{"value":"6,007,797"},{"value":"5,586.5388"}],[{"value":"Czech Republic"},{"value":"Europe"},{"value":"1,952"},{"value":"1"},{"value":"66.8700"},{"value":"9,125,183"},{"value":"6,876.1403"}],[{"value":"Denmark"},{"value":"Europe"},{"value":"1,952"},{"value":"1"},{"value":"70.7800"},{"value":"4,334,000"},{"value":"9,692.3852"}],[{"value":"Djibouti"},{"value":"Africa"},{"value":"1,952"},{"value":"1"},{"value":"34.8120"},{"value":"63,149"},{"value":"2,669.5295"}],[{"value":"Dominican Republic"},{"value":"Americas"},{"value":"1,952"},{"value":"1"},{"value":"45.9280"},{"value":"2,491,346"},{"value":"1,397.7171"}],[{"value":"Ecuador"},{"value":"Americas"},{"value":"1,952"},{"value":"1"},{"value":"48.3570"},{"value":"3,548,753"},{"value":"3,522.1107"}],[{"value":"Egypt"},{"value":"Africa"},{"value":"1,952"},{"value":"1"},{"value":"41.8930"},{"value":"22,223,309"},{"value":"1,418.8224"}],[{"value":"El Salvador"},{"value":"Americas"},{"value":"1,952"},{"value":"1"},{"value":"45.2620"},{"value":"2,042,865"},{"value":"3,048.3029"}],[{"value":"Equatorial Guinea"},{"value":"Africa"},{"value":"1,952"},{"value":"1"},{"value":"34.4820"},{"value":"216,964"},{"value":"375.6431"}],[{"value":"Eritrea"},{"value":"Africa"},{"value":"1,952"},{"value":"1"},{"value":"35.9280"},{"value":"1,438,760"},{"value":"328.9406"}],[{"value":"Ethiopia"},{"value":"Africa"},{"value":"1,952"},{"value":"1"},{"value":"34.0780"},{"value":"20,860,941"},{"value":"362.1463"}],[{"value":"Finland"},{"value":"Europe"},{"value":"1,952"},{"value":"1"},{"value":"66.5500"},{"value":"4,090,500"},{"value":"6,424.5191"}],[{"value":"France"},{"value":"Europe"},{"value":"1,952"},{"value":"1"},{"value":"67.4100"},{"value":"42,459,667"},{"value":"7,029.8093"}],[{"value":"Gabon"},{"value":"Africa"},{"value":"1,952"},{"value":"1"},{"value":"37.0030"},{"value":"420,702"},{"value":"4,293.4765"}],[{"value":"Gambia"},{"value":"Africa"},{"value":"1,952"},{"value":"1"},{"value":"30.0000"},{"value":"284,320"},{"value":"485.2307"}],[{"value":"Germany"},{"value":"Europe"},{"value":"1,952"},{"value":"1"},{"value":"67.5000"},{"value":"69,145,952"},{"value":"7,144.1144"}],[{"value":"Ghana"},{"value":"Africa"},{"value":"1,952"},{"value":"1"},{"value":"43.1490"},{"value":"5,581,001"},{"value":"911.2989"}],[{"value":"Greece"},{"value":"Europe"},{"value":"1,952"},{"value":"1"},{"value":"65.8600"},{"value":"7,733,250"},{"value":"3,530.6901"}],[{"value":"Guatemala"},{"value":"Americas"},{"value":"1,952"},{"value":"1"},{"value":"42.0230"},{"value":"3,146,381"},{"value":"2,428.2378"}],[{"value":"Guinea"},{"value":"Africa"},{"value":"1,952"},{"value":"1"},{"value":"33.6090"},{"value":"2,664,249"},{"value":"510.1965"}],[{"value":"Guinea-Bissau"},{"value":"Africa"},{"value":"1,952"},{"value":"1"},{"value":"32.5000"},{"value":"580,653"},{"value":"299.8503"}],[{"value":"Haiti"},{"value":"Americas"},{"value":"1,952"},{"value":"1"},{"value":"37.5790"},{"value":"3,201,488"},{"value":"1,840.3669"}],[{"value":"Honduras"},{"value":"Americas"},{"value":"1,952"},{"value":"1"},{"value":"41.9120"},{"value":"1,517,453"},{"value":"2,194.9262"}],[{"value":"Hong Kong, China"},{"value":"Asia"},{"value":"1,952"},{"value":"1"},{"value":"60.9600"},{"value":"2,125,900"},{"value":"3,054.4212"}],[{"value":"Hungary"},{"value":"Europe"},{"value":"1,952"},{"value":"1"},{"value":"64.0300"},{"value":"9,504,000"},{"value":"5,263.6738"}],[{"value":"Iceland"},{"value":"Europe"},{"value":"1,952"},{"value":"1"},{"value":"72.4900"},{"value":"147,962"},{"value":"7,267.6884"}],[{"value":"India"},{"value":"Asia"},{"value":"1,952"},{"value":"1"},{"value":"37.3730"},{"value":"372,000,000"},{"value":"546.5657"}],[{"value":"Indonesia"},{"value":"Asia"},{"value":"1,952"},{"value":"1"},{"value":"37.4680"},{"value":"82,052,000"},{"value":"749.6817"}],[{"value":"Iran"},{"value":"Asia"},{"value":"1,952"},{"value":"1"},{"value":"44.8690"},{"value":"17,272,000"},{"value":"3,035.3260"}],[{"value":"Iraq"},{"value":"Asia"},{"value":"1,952"},{"value":"1"},{"value":"45.3200"},{"value":"5,441,766"},{"value":"4,129.7661"}],[{"value":"Ireland"},{"value":"Europe"},{"value":"1,952"},{"value":"1"},{"value":"66.9100"},{"value":"2,952,156"},{"value":"5,210.2803"}],[{"value":"Israel"},{"value":"Asia"},{"value":"1,952"},{"value":"1"},{"value":"65.3900"},{"value":"1,620,914"},{"value":"4,086.5221"}],[{"value":"Italy"},{"value":"Europe"},{"value":"1,952"},{"value":"1"},{"value":"65.9400"},{"value":"47,666,000"},{"value":"4,931.4042"}],[{"value":"Jamaica"},{"value":"Americas"},{"value":"1,952"},{"value":"1"},{"value":"58.5300"},{"value":"1,426,095"},{"value":"2,898.5309"}],[{"value":"Japan"},{"value":"Asia"},{"value":"1,952"},{"value":"1"},{"value":"63.0300"},{"value":"86,459,025"},{"value":"3,216.9563"}],[{"value":"Jordan"},{"value":"Asia"},{"value":"1,952"},{"value":"1"},{"value":"43.1580"},{"value":"607,914"},{"value":"1,546.9078"}],[{"value":"Kenya"},{"value":"Africa"},{"value":"1,952"},{"value":"1"},{"value":"42.2700"},{"value":"6,464,046"},{"value":"853.5409"}],[{"value":"Korea, Dem. Rep."},{"value":"Asia"},{"value":"1,952"},{"value":"1"},{"value":"50.0560"},{"value":"8,865,488"},{"value":"1,088.2778"}],[{"value":"Korea, Rep."},{"value":"Asia"},{"value":"1,952"},{"value":"1"},{"value":"47.4530"},{"value":"20,947,571"},{"value":"1,030.5922"}],[{"value":"Kuwait"},{"value":"Asia"},{"value":"1,952"},{"value":"1"},{"value":"55.5650"},{"value":"160,000"},{"value":"108,382.3529"}],[{"value":"Lebanon"},{"value":"Asia"},{"value":"1,952"},{"value":"1"},{"value":"55.9280"},{"value":"1,439,529"},{"value":"4,834.8041"}],[{"value":"Lesotho"},{"value":"Africa"},{"value":"1,952"},{"value":"1"},{"value":"42.1380"},{"value":"748,747"},{"value":"298.8462"}],[{"value":"Liberia"},{"value":"Africa"},{"value":"1,952"},{"value":"1"},{"value":"38.4800"},{"value":"863,308"},{"value":"575.5730"}],[{"value":"Libya"},{"value":"Africa"},{"value":"1,952"},{"value":"1"},{"value":"42.7230"},{"value":"1,019,729"},{"value":"2,387.5481"}],[{"value":"Madagascar"},{"value":"Africa"},{"value":"1,952"},{"value":"1"},{"value":"36.6810"},{"value":"4,762,912"},{"value":"1,443.0117"}],[{"value":"Malawi"},{"value":"Africa"},{"value":"1,952"},{"value":"1"},{"value":"36.2560"},{"value":"2,917,802"},{"value":"369.1651"}],[{"value":"Malaysia"},{"value":"Asia"},{"value":"1,952"},{"value":"1"},{"value":"48.4630"},{"value":"6,748,378"},{"value":"1,831.1329"}],[{"value":"Mali"},{"value":"Africa"},{"value":"1,952"},{"value":"1"},{"value":"33.6850"},{"value":"3,838,168"},{"value":"452.3370"}],[{"value":"Mauritania"},{"value":"Africa"},{"value":"1,952"},{"value":"1"},{"value":"40.5430"},{"value":"1,022,556"},{"value":"743.1159"}],[{"value":"Mauritius"},{"value":"Africa"},{"value":"1,952"},{"value":"1"},{"value":"50.9860"},{"value":"516,556"},{"value":"1,967.9557"}],[{"value":"Mexico"},{"value":"Americas"},{"value":"1,952"},{"value":"1"},{"value":"50.7890"},{"value":"30,144,317"},{"value":"3,478.1255"}],[{"value":"Mongolia"},{"value":"Asia"},{"value":"1,952"},{"value":"1"},{"value":"42.2440"},{"value":"800,663"},{"value":"786.5669"}],[{"value":"Montenegro"},{"value":"Europe"},{"value":"1,952"},{"value":"1"},{"value":"59.1640"},{"value":"413,834"},{"value":"2,647.5856"}],[{"value":"Morocco"},{"value":"Africa"},{"value":"1,952"},{"value":"1"},{"value":"42.8730"},{"value":"9,939,217"},{"value":"1,688.2036"}],[{"value":"Mozambique"},{"value":"Africa"},{"value":"1,952"},{"value":"1"},{"value":"31.2860"},{"value":"6,446,316"},{"value":"468.5260"}],[{"value":"Myanmar"},{"value":"Asia"},{"value":"1,952"},{"value":"1"},{"value":"36.3190"},{"value":"20,092,996"},{"value":"331.0000"}],[{"value":"Namibia"},{"value":"Africa"},{"value":"1,952"},{"value":"1"},{"value":"41.7250"},{"value":"485,831"},{"value":"2,423.7804"}],[{"value":"Nepal"},{"value":"Asia"},{"value":"1,952"},{"value":"1"},{"value":"36.1570"},{"value":"9,182,536"},{"value":"545.8657"}],[{"value":"Netherlands"},{"value":"Europe"},{"value":"1,952"},{"value":"1"},{"value":"72.1300"},{"value":"10,381,988"},{"value":"8,941.5719"}],[{"value":"New Zealand"},{"value":"Oceania"},{"value":"1,952"},{"value":"1"},{"value":"69.3900"},{"value":"1,994,794"},{"value":"10,556.5757"}],[{"value":"Nicaragua"},{"value":"Americas"},{"value":"1,952"},{"value":"1"},{"value":"42.3140"},{"value":"1,165,790"},{"value":"3,112.3639"}],[{"value":"Niger"},{"value":"Africa"},{"value":"1,952"},{"value":"1"},{"value":"37.4440"},{"value":"3,379,468"},{"value":"761.8794"}],[{"value":"Nigeria"},{"value":"Africa"},{"value":"1,952"},{"value":"1"},{"value":"36.3240"},{"value":"33,119,096"},{"value":"1,077.2819"}],[{"value":"Norway"},{"value":"Europe"},{"value":"1,952"},{"value":"1"},{"value":"72.6700"},{"value":"3,327,728"},{"value":"10,095.4217"}],[{"value":"Oman"},{"value":"Asia"},{"value":"1,952"},{"value":"1"},{"value":"37.5780"},{"value":"507,833"},{"value":"1,828.2303"}],[{"value":"Pakistan"},{"value":"Asia"},{"value":"1,952"},{"value":"1"},{"value":"43.4360"},{"value":"41,346,560"},{"value":"684.5971"}],[{"value":"Panama"},{"value":"Americas"},{"value":"1,952"},{"value":"1"},{"value":"55.1910"},{"value":"940,080"},{"value":"2,480.3803"}],[{"value":"Paraguay"},{"value":"Americas"},{"value":"1,952"},{"value":"1"},{"value":"62.6490"},{"value":"1,555,876"},{"value":"1,952.3087"}]]}}}}