datasets icon indicating copy to clipboard operation
datasets copied to clipboard

docs with example?

Open hcientist opened this issue 6 years ago • 2 comments

I can see that there's some description of the individual data sets on their respective web pages (e.g. https://think.cs.vt.edu/corgis/blockpy/food_access/ ), but is there doc that shows the api of these modules? dir wasn't as illuminating as I'd hoped...

hcientist avatar Nov 17 '19 20:11 hcientist

Just a head's up, we've been transitioning to a new repo: https://github.com/corgis-edu/corgis

Are you using the BlockPy dataset, or the Python dataset? If you check the Python version, you can see the API more clearly: https://think.cs.vt.edu/corgis/python/food_access/

If you're using the BlockPy side, then it's expected that you'd use the Blocks to access the datasets (obviating the textual API). The code shown in the Python version works in BlockPy too, although there's an additional API function that's not supported in the Python mode (since it trivializes some of our assignments to support too convenient filtering).

acbart avatar Nov 17 '19 20:11 acbart

Awesome, thanks. That gets me rolling, I'll leave it to y'all to decide if you want this to remain open to remind you to document, but perhaps you don't need to given that python api page.

hcientist avatar Nov 17 '19 20:11 hcientist