Examples/ broken or unclear in Torque Repo

[auremoser]

Context

:) In the wake of the Torque landing page release and blog post, maybe we should merge in existing branches that show more examples (ie voronoi!!! etc.)?

Also, it would be cool to remove or tweek some of the broken ones since the landing page and partner blog points to them as sample torque.

cc @andrewxhill

Expected Result

If I download the Torque repo, I should be able to run all of the examples/, and know what is happening in each.

Current Result

• car.html is intuitive, the naming convention for a few others isn't; it would be nice to have a little readme.txt file in the examples directory saying what each was, unless this is already described in the html header comments
  • navy_gmaps is clear to me, light_bright.html is awesome but does it show multivariate data (like the size and temporality of points both have significant insight to the data) that's awesome, but light_bright does not communicate that
  • sql.html isn't an html file, it gives an sql statement, and I'm not sure what it illustrates to complement the other examples
• the static maps are cool, but why you would want to render static maps with a temporal animation library is unclear, there is probably a usecase that is totally valid, but why you wouldn't just choose to do a point map (say, you want to show all of the points at one time, you could do this with a sql query, you don't need torque, why is this a torque example?)
• tilejson.html and tilejson.json, why are they paired and useful as examples? (again, there is probably a totes legit reason, it just should be explained somewhere.

3 Possible Fixes

• could we just add html comments to the top of all the examples?
• or provide a readme.txt or an index.txt explaining the usecase of each
• or just shift files in and out of the master branch that are particularly relevant for the new release

I'm happy to help, I just don't want to step on toes or move something without asking first!
Thank you for reading!

[fdansv]

Hey!

merge in existing branches that show more examples (ie voronoi!!! etc.)?

That's an experimental branch created during a leapfrog afternoon by Santana. There's more to it than just the example and for now we have no plans of moving voronoi to production

sql.html isn't an html file, it gives an sql statement, and I'm not sure what it illustrates to complement the other examples

Ha, no idea what's that doing there. But it's probably fine to remove it.

say, you want to show all of the points at one time, you could do this with a sql query, you don't need torque, why is this a torque example?

Not sure which examples you're referring to, but the most important use case for static maps are heatmaps, which are not usually animated.

tilejson.html and tilejson.json, why are they paired and useful as examples? (again, there is probably a totes legit reason, it just should be explained somewhere.

This still needs to be properly documented, but the tilejson provider was merged to master last week as part of the Torque release. It allows the library to load torque tiles regardless of who/what is serving them.

I'm happy to help, I just don't want to step on toes or move something without asking first!

The examples part of this repo needs love, so feel free to add/remove/edit anything and PR it :)