CartoDB / cartoframes

CARTO Python package for data scientists
BSD 3-Clause "New" or "Revised" License
250 stars 63 forks source link

Add Carto Documentation for DO #407

Closed stuartlynn closed 6 years ago

michellemho commented 6 years ago

Ready for review!

michellemho commented 6 years ago

Just can't figure out how to add a space and capitalization...

image

andy-esch commented 6 years ago

@michellemho I updated the filename to add the space now, but it unfortunately doesn't capitalize the second word... I think we'll need to do a feature request.

michellemho commented 6 years ago

Strange! That's OK though for now. Thanks, Andy!

On Mon, Apr 9, 2018 at 9:39 AM, Andy Eschbacher notifications@github.com wrote:

@michellemho https://github.com/michellemho I updated the filename to add the space now, but it unfortunately doesn't capitalize the second word.

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/CartoDB/cartoframes/issues/407#issuecomment-379755281, or mute the thread https://github.com/notifications/unsubscribe-auth/AL-ECfJyo5yXp9Tg6WpjyZJ4_K6KpRYUks5tm2SQgaJpZM4TFghz .

-- Michelle Ho Data Scientist mho@carto.com https://carto.com/locations-event/

andy-esch commented 6 years ago

Heya @michellemho, I made some edits and listed some TODOs in the DO guide in this PR: https://github.com/CartoDB/cartoframes/pull/414

Could you take a look at that and update where you think is appropriate? Images can be included as:

\<img src="https://cartoframes.carto.com/api/v1/map/static/named/cartoframes_ver20170406_layers0_time0_baseid2_labels0_zoom1/800/400.png?config=%7B%22basemap_url%22%3A+%22https%3A%2F%2F%7Bs%7D.basemaps.cartocdn.com%2Frastertiles%2Fvoyager_labels_under%2F%7Bz%7D%2F%7Bx%7D%2F%7By%7D.png%22%7D&anti_cache=0.8603790764089185&zoom=1&lat=0&lon=0" />

We can store the files etc in the cartoframes.carto.com account so ping me if you need access to that.

michellemho commented 6 years ago

Hi Andy!

Looks good. Thanks for adding more text to describe the process :)

I was wondering if we should add examples of the metadata results? Maybe as a screenshot? Unfortunately, the table is really wide and Pandas truncates some of the columns anyway, but maybe it's a good idea to give the user what one row looks like? We could also create a markdown table after education_meta.iloc[0].value. I'll give it a try and see how it looks.

On Tue, Apr 10, 2018 at 12:13 PM, Andy Eschbacher notifications@github.com wrote:

Heya @michellemho https://github.com/michellemho, I made some edits and listed some TODOs in the DO guide in this PR: #414 https://github.com/CartoDB/cartoframes/pull/414

Could you take a look at that and update where you think is appropriate? Images can be included as: ```

https://camo.githubusercontent.com/9a499ef322aaf2e06ca962791a37bc15c1ef6d5a/68747470733a2f2f636172746f6672616d65732e636172746f2e636f6d2f6170692f76312f6d61702f7374617469632f6e616d65642f636172746f6672616d65735f76657232303137303430365f6c6179657273305f74696d65305f626173656964325f6c6162656c73305f7a6f6f6d312f3830302f3430302e706e673f636f6e6669673d253742253232626173656d61705f75726c2532322533412b2532326874747073253341253246253246253742732537442e626173656d6170732e636172746f63646e2e636f6d25324672617374657274696c6573253246766f79616765725f6c6162656c735f756e6465722532462537427a25374425324625374278253744253246253742792537442e706e6725323225374426616e74695f63616368653d302e38363033373930373634303839313835267a6f6f6d3d31266c61743d30266c6f6e3d30

We can store the files etc in the cartoframes.carto.com account so ping me if you need access to that.

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/CartoDB/cartoframes/issues/407#issuecomment-380159116, or mute the thread https://github.com/notifications/unsubscribe-auth/AL-ECZHL1Eut1RzXuX8MuXklScUvYaKxks5tnNocgaJpZM4TFghz .

-- Michelle Ho Data Scientist mho@carto.com https://carto.com/locations-event/

michellemho commented 6 years ago

Also noticed the addition of cc.load_nyc_census_tracts(), but I can't get this function or method to work. Does it not exist yet?

andy-esch commented 6 years ago

Not yet, could be yours if you need it for the demo :) I just wanted a concise way to start. Just a suggestion. On Tue, Apr 10, 2018 at 5:28 PM Michelle Ho notifications@github.com wrote:

Also noticed the addition of cc.load_nyc_census_tracts(), but I can't get this function or method to work. Does it not exist yet?

— You are receiving this because you commented. Reply to this email directly, view it on GitHub https://github.com/CartoDB/cartoframes/issues/407#issuecomment-380252581, or mute the thread https://github.com/notifications/unsubscribe-auth/AA_ioKPhp4Ty6mmFpADWOkaY1m1hWPbPks5tnSP1gaJpZM4TFghz .

-- Andy Eschbacher Map Scientist CARTO @MrEPhysics https://twitter.com/MrEPhysics

michellemho commented 6 years ago

Some issues I found:

education_meta.iloc[0].value returns an error that AttributeError: 'Series' object has no attribute 'value', so I'm dropping the "value".

This query returns nothing, so I'm replacing it with a search for "college"! education_meta[education_meta.numer_description.str.contains('secondary')]

Also, not sure how we're hosting files at cartoframes.carto.com. How do you create that PNG image?

michellemho commented 6 years ago

Hm, I'm getting an error running grunt serve so I'm unable to preview what these changes look like... any advice?

CARTOs-Air:documentation mho$ grunt serve
Running "serve" task

Running "clean:dist" (clean) task
>> 2 paths cleaned.

Running "copy:hangar" (copy) task
Copied 52 files

Running "copy:dist" (copy) task
Copied 27 files

Running "folder_list:default_options" (folder_list) task
File "_app/carto-js/_data/sidebar_guides.yml" created.
File "_app/carto-js/_data/sidebar_support.yml" created.
File "_app/carto-js/_data/sidebar_reference.yml" created.
File "_app/fundamentals/_data/sidebar.yml" created.
File "_app/auth-api/_data/sidebar_guides.yml" created.
File "_app/auth-api/_data/sidebar_support.yml" created.
File "_app/data-observatory/_data/sidebar_guides.yml" created.
File "_app/data-observatory/_data/sidebar_support.yml" created.
File "_app/data-observatory/_data/sidebar_reference.yml" created.
File "_app/torque-js/_data/sidebar_guides.yml" created.
File "_app/torque-js/_data/sidebar_reference.yml" created.
File "_app/torque-js/_data/sidebar_support.yml" created.
File "_app/tools/_data/sidebar.yml" created.
File "_app/data-services-api/_data/sidebar_guides.yml" created.
File "_app/data-services-api/_data/sidebar_reference.yml" created.
File "_app/data-services-api/_data/sidebar_support.yml" created.
File "_app/maps-api/_data/sidebar_guides.yml" created.
File "_app/maps-api/_data/sidebar_reference.yml" created.
File "_app/maps-api/_data/sidebar_support.yml" created.
File "_app/sql-api/_data/sidebar_guides.yml" created.
File "_app/sql-api/_data/sidebar_reference.yml" created.
File "_app/sql-api/_data/sidebar_support.yml" created.
File "_app/python-sdk/_data/sidebar_guides.yml" created.
File "_app/import-api/_data/sidebar_reference.yml" created.
File "_app/import-api/_data/sidebar_support.yml" created.
File "_app/import-api/_data/sidebar_guides.yml" created.
File "_app/carto-vl/_data/sidebar_support.yml" created.
File "_app/carto-vl/_data/sidebar_guides.yml" created.
File "_app/carto-frames/_data/sidebar_support.yml" created.
File "_app/carto-frames/_data/sidebar_guides.yml" created.
File "_app/mobile-sdk/_data/sidebar_reference.yml" created.
File "_app/mobile-sdk/_data/sidebar_support.yml" created.
File "_app/mobile-sdk/_data/sidebar_guides.yml" created.
File "_app/on-premise/_data/sidebar_guides.yml" created.

Running "shell:development" (shell) task
bundler: failed to load command: jekyll (/usr/local/bin/jekyll)
Bundler::GemNotFound: Could not find concurrent-ruby-1.0.5 in any of the sources
  /usr/local/Cellar/ruby/2.5.1/lib/ruby/2.5.0/bundler/spec_set.rb:88:in `block in materialize'
  /usr/local/Cellar/ruby/2.5.1/lib/ruby/2.5.0/bundler/spec_set.rb:82:in `map!'
  /usr/local/Cellar/ruby/2.5.1/lib/ruby/2.5.0/bundler/spec_set.rb:82:in `materialize'
  /usr/local/Cellar/ruby/2.5.1/lib/ruby/2.5.0/bundler/definition.rb:170:in `specs'
  /usr/local/Cellar/ruby/2.5.1/lib/ruby/2.5.0/bundler/definition.rb:237:in `specs_for'
  /usr/local/Cellar/ruby/2.5.1/lib/ruby/2.5.0/bundler/definition.rb:226:in `requested_specs'
  /usr/local/Cellar/ruby/2.5.1/lib/ruby/2.5.0/bundler/runtime.rb:108:in `block in definition_method'
  /usr/local/Cellar/ruby/2.5.1/lib/ruby/2.5.0/bundler/runtime.rb:20:in `setup'
  /usr/local/Cellar/ruby/2.5.1/lib/ruby/2.5.0/bundler.rb:107:in `setup'
  /usr/local/Cellar/ruby/2.5.1/lib/ruby/2.5.0/bundler/setup.rb:20:in `<top (required)>'
  /usr/local/Cellar/ruby/2.5.1/lib/ruby/2.5.0/rubygems/core_ext/kernel_require.rb:59:in `require'
  /usr/local/Cellar/ruby/2.5.1/lib/ruby/2.5.0/rubygems/core_ext/kernel_require.rb:59:in `require'
Warning: Command failed: bundle exec jekyll build --incremental --limit 30
Bundler::GemNotFound: Could not find concurrent-ruby-1.0.5 in any of the sources
  /usr/local/Cellar/ruby/2.5.1/lib/ruby/2.5.0/bundler/spec_set.rb:88:in `block in materialize'
  /usr/local/Cellar/ruby/2.5.1/lib/ruby/2.5.0/bundler/spec_set.rb:82:in `map!'
  /usr/local/Cellar/ruby/2.5.1/lib/ruby/2.5.0/bundler/spec_set.rb:82:in `materialize'
  /usr/local/Cellar/ruby/2.5.1/lib/ruby/2.5.0/bundler/definition.rb:170:in `specs'
  /usr/local/Cellar/ruby/2.5.1/lib/ruby/2.5.0/bundler/definition.rb:237:in `specs_for'
  /usr/local/Cellar/ruby/2.5.1/lib/ruby/2.5.0/bundler/definition.rb:226:in `requested_specs'
  /usr/local/Cellar/ruby/2.5.1/lib/ruby/2.5.0/bundler/runtime.rb:108:in `block in definition_method'
  /usr/local/Cellar/ruby/2.5.1/lib/ruby/2.5.0/bundler/runtime.rb:20:in `setup'
  /usr/local/Cellar/ruby/2.5.1/lib/ruby/2.5.0/bundler.rb:107:in `setup'
  /usr/local/Cellar/ruby/2.5.1/lib/ruby/2.5.0/bundler/setup.rb:20:in `<top (required)>'
  /usr/local/Cellar/ruby/2.5.1/lib/ruby/2.5.0/rubygems/core_ext/kernel_require.rb:59:in `require'
  /usr/local/Cellar/ruby/2.5.1/lib/ruby/2.5.0/rubygems/core_ext/kernel_require.rb:59:in `require'
 Use --force to continue.

Aborted due to warnings.

Execution Time (2018-04-11 21:21:25 UTC)
loading tasks               5.4s  ▇▇▇▇▇▇▇▇▇▇▇▇▇ 36%
clean:dist                 178ms  ▇ 1%
copy:hangar                436ms  ▇▇ 3%
copy:dist                   2.1s  ▇▇▇▇▇ 14%
loading grunt-folder-list  154ms  ▇ 1%
shell:development           6.7s  ▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇▇ 44%
Total 15.2s

CARTOs-Air:documentation mho$ grunt serve
Running "serve" task

Running "clean:dist" (clean) task
>> 1 path cleaned.

Running "copy:hangar" (copy) task
Copied 52 files

Running "copy:dist" (copy) task
Copied 27 files

Running "folder_list:default_options" (folder_list) task
File "_app/carto-js/_data/sidebar_guides.yml" created.
File "_app/carto-js/_data/sidebar_support.yml" created.
File "_app/carto-js/_data/sidebar_reference.yml" created.
File "_app/fundamentals/_data/sidebar.yml" created.
File "_app/auth-api/_data/sidebar_guides.yml" created.
File "_app/auth-api/_data/sidebar_support.yml" created.
File "_app/data-observatory/_data/sidebar_guides.yml" created.
File "_app/data-observatory/_data/sidebar_support.yml" created.
File "_app/data-observatory/_data/sidebar_reference.yml" created.
File "_app/torque-js/_data/sidebar_guides.yml" created.
File "_app/torque-js/_data/sidebar_reference.yml" created.
File "_app/torque-js/_data/sidebar_support.yml" created.
File "_app/tools/_data/sidebar.yml" created.
File "_app/data-services-api/_data/sidebar_guides.yml" created.
File "_app/data-services-api/_data/sidebar_reference.yml" created.
File "_app/data-services-api/_data/sidebar_support.yml" created.
File "_app/maps-api/_data/sidebar_guides.yml" created.
File "_app/maps-api/_data/sidebar_reference.yml" created.
File "_app/maps-api/_data/sidebar_support.yml" created.
File "_app/sql-api/_data/sidebar_guides.yml" created.
File "_app/sql-api/_data/sidebar_reference.yml" created.
File "_app/sql-api/_data/sidebar_support.yml" created.
File "_app/python-sdk/_data/sidebar_guides.yml" created.
File "_app/import-api/_data/sidebar_reference.yml" created.
File "_app/import-api/_data/sidebar_support.yml" created.
File "_app/import-api/_data/sidebar_guides.yml" created.
File "_app/carto-vl/_data/sidebar_support.yml" created.
File "_app/carto-vl/_data/sidebar_guides.yml" created.
File "_app/carto-frames/_data/sidebar_support.yml" created.
File "_app/carto-frames/_data/sidebar_guides.yml" created.
File "_app/mobile-sdk/_data/sidebar_reference.yml" created.
File "_app/mobile-sdk/_data/sidebar_support.yml" created.
File "_app/mobile-sdk/_data/sidebar_guides.yml" created.
File "_app/on-premise/_data/sidebar_guides.yml" created.

Running "shell:development" (shell) task
bundler: failed to load command: jekyll (/usr/local/bin/jekyll)
Bundler::GemNotFound: Could not find concurrent-ruby-1.0.5 in any of the sources
  /usr/local/Cellar/ruby/2.5.1/lib/ruby/2.5.0/bundler/spec_set.rb:88:in `block in materialize'
  /usr/local/Cellar/ruby/2.5.1/lib/ruby/2.5.0/bundler/spec_set.rb:82:in `map!'
  /usr/local/Cellar/ruby/2.5.1/lib/ruby/2.5.0/bundler/spec_set.rb:82:in `materialize'
  /usr/local/Cellar/ruby/2.5.1/lib/ruby/2.5.0/bundler/definition.rb:170:in `specs'
  /usr/local/Cellar/ruby/2.5.1/lib/ruby/2.5.0/bundler/definition.rb:237:in `specs_for'
  /usr/local/Cellar/ruby/2.5.1/lib/ruby/2.5.0/bundler/definition.rb:226:in `requested_specs'
  /usr/local/Cellar/ruby/2.5.1/lib/ruby/2.5.0/bundler/runtime.rb:108:in `block in definition_method'
  /usr/local/Cellar/ruby/2.5.1/lib/ruby/2.5.0/bundler/runtime.rb:20:in `setup'
  /usr/local/Cellar/ruby/2.5.1/lib/ruby/2.5.0/bundler.rb:107:in `setup'
  /usr/local/Cellar/ruby/2.5.1/lib/ruby/2.5.0/bundler/setup.rb:20:in `<top (required)>'
  /usr/local/Cellar/ruby/2.5.1/lib/ruby/2.5.0/rubygems/core_ext/kernel_require.rb:59:in `require'
  /usr/local/Cellar/ruby/2.5.1/lib/ruby/2.5.0/rubygems/core_ext/kernel_require.rb:59:in `require'
Warning: Command failed: bundle exec jekyll build --incremental --limit 30
Bundler::GemNotFound: Could not find concurrent-ruby-1.0.5 in any of the sources
  /usr/local/Cellar/ruby/2.5.1/lib/ruby/2.5.0/bundler/spec_set.rb:88:in `block in materialize'
  /usr/local/Cellar/ruby/2.5.1/lib/ruby/2.5.0/bundler/spec_set.rb:82:in `map!'
  /usr/local/Cellar/ruby/2.5.1/lib/ruby/2.5.0/bundler/spec_set.rb:82:in `materialize'
  /usr/local/Cellar/ruby/2.5.1/lib/ruby/2.5.0/bundler/definition.rb:170:in `specs'
  /usr/local/Cellar/ruby/2.5.1/lib/ruby/2.5.0/bundler/definition.rb:237:in `specs_for'
  /usr/local/Cellar/ruby/2.5.1/lib/ruby/2.5.0/bundler/definition.rb:226:in `requested_specs'
  /usr/local/Cellar/ruby/2.5.1/lib/ruby/2.5.0/bundler/runtime.rb:108:in `block in definition_method'
  /usr/local/Cellar/ruby/2.5.1/lib/ruby/2.5.0/bundler/runtime.rb:20:in `setup'
  /usr/local/Cellar/ruby/2.5.1/lib/ruby/2.5.0/bundler.rb:107:in `setup'
  /usr/local/Cellar/ruby/2.5.1/lib/ruby/2.5.0/bundler/setup.rb:20:in `<top (required)>'
  /usr/local/Cellar/ruby/2.5.1/lib/ruby/2.5.0/rubygems/core_ext/kernel_require.rb:59:in `require'
  /usr/local/Cellar/ruby/2.5.1/lib/ruby/2.5.0/rubygems/core_ext/kernel_require.rb:59:in `require'
 Use --force to continue.

Aborted due to warnings.

Execution Time (2018-04-11 21:22:00 UTC)
loading tasks                   1s  ▇▇▇▇▇▇▇▇▇▇▇▇ 36%
copy:hangar                  331ms  ▇▇▇▇ 12%
copy:dist                    370ms  ▇▇▇▇▇ 13%
folder_list:default_options   76ms  ▇ 3%
shell:development               1s  ▇▇▇▇▇▇▇▇▇▇▇▇ 35%
Total 2.9s
andy-esch commented 6 years ago

Done in https://github.com/CartoDB/cartoframes/pull/414