Skip to content

Remake and more

Compare
Choose a tag to compare
@aappling-usgs aappling-usgs released this 08 Feb 17:37
64d3610

This release finalizes our October 2017 Sprint, with follow up through February 2018, by Appling, DeCicco, Oliver, Read, Wernimont, and Zwart

In future vizzies, you should…

  • DON'T bother with createProfile() or createMakefiles(), or using make to build. DO:
    • run vizmake() in the R console to build the viz, no configuration required
    • run vizid <- vizmake('vizid') for one ID to build that step and its dependencies
  • DON'T bother with log files for diagnosing problems. DO:
    • add browser() lines to use as breakpoints during vizmake() runs, or
    • add browser() lines during vizmake('vizid') for a single viz id, or
    • add RStudio breakpoints and call fetch('vizid') (or process, etc.), or
    • get the read-in output of individual targets with vizid <- vizmake('vizid')
  • DO read and edit the vizlab wiki - we added a lot, including:
    • rules of engagement for viz sprints
    • a style guide
    • an explanation of fetch and fetchTimestamp
  • DON'T set a default like viz=as.viz('viewbox') in fetch/etc. methods. DO use this format:
    fetch.viewbox <- function(viz)
    and then call
    debug(fetch.viewbox); fetch('viewbox') or
    debug(fetch.viewbox); vizmake('viewbox')
    to run the method
  • DO create fetch items that depend on process items when needed
  • DO try out fetch.usgs_watermark, readData.shp, and readData.svg
  • DO try out publish.json and publish.tabular for preparing data for use with d3 or jquery
  • DO use the new hovertext function from inst/js/tooltip.js, which keeps itself visible and moves around smoothly

What we did

  • Improved thumbnails
    • Simplified information required in viz.yaml
  • Fixed embedding
  • Switched from make to remake
    • vizmake acts much like remake::make but with bonus features
    • Fetch items can depend on process items
    • Prints time at start and end of each build
    • Timestamps are better tested and sure seem to be working
    • The build may be faster. Skipping unnecessary steps (see timestamps ^^) definitely makes it faster
  • Improved built-in tooltip support
    • Moves smoothly with mouse
    • Doesn't get clipped by the edges of the svg
    • Multiple svgs are possible
  • Added data-handling functions
    • fetch.usgs_watermark - grabs USGS letters and wave for watermark placement
    • readData.shp - assumes 1 layer in the shapefile. More specific shapefile readers with indexing capabilities will be created for vizstorm
    • readData.svg - should work for any svg
  • Upgraded our analytics
    • Added DOI analytics code
    • Upgraded to new Google Analytics system
    • Added a tracker or two
  • Improved our branding
    • Retina favicon on viz & landing pages
    • Removed OWI logo from landing page
    • Added "U.S. Geological Survey" to footer
  • Curated the issues