viz.yaml

vizlab: "0.1.7"
info:
  id: gages-through-ages
  name: Stream Gages Through the Ages
  date: 2017-03-08
  publish-date: 
  path: /gages-through-ages
  analytics-id: UA-78530187-1
  description: >-
    The U.S. Geological Survey Groundwater and Streamflow Information Program is 
    funded by Congress to monitor drought and flood across the US through a network 
    of stream gages. The USGS has been monitoring streamflow since 1889, and data 
    from streamgages have since become critical to hydropower operations, recreation,
    streamflow prediction, flood forecasts, emergency management, engineering designs,
    and many other purposes. This data visualization shows an animation of stream gages
    since the late 1800s, by year, across the US. In addition, records from one of the
    oldest continuously active USGS stream gages, on the Rio Grande River at Embudo, NM,
    is shown in an interactive plot.  
  audience: General public
  keywords: [ "water", "USGS", "VIZLAB", "stream gages" ]
  url: https://owi.usgs.gov/vizlab/gages-through-ages/
  thumbnail:  
    url:  "none"  
    width: 250    
    height: 250    
    alttext: "some text here"
  thumbnail-landing: 
    url: "none"
  contributors:
    -
      name: Mary Bucknell
      email: mbucknell@usgs.gov
      affiliation: U.S. Geological Survey
    -
      name: Lindsay Carr
      email: lcarr@usgs.gov
      affiliation: U.S. Geological Survey
    -
      name: Laura DeCicco
      email: ldecicco@usgs.gov
      affiliation: U.S. Geological Survey
    -
      name: Emily Read
      email: eread@usgs.gov
      affiliation: U.S. Geological Survey
    -
      name: Jordan Read
      email: jread@usgs.gov
      affiliation: U.S. Geological Survey
    -
      name: Jordan Walker
      email: jiwalker@usgs.gov
      affiliation: U.S. Geological Survey
    -
      name: David Watkins
      email: wwatkins@usgs.gov
      affiliation: U.S. Geological Survey
    -
      name: Marty Wernimont
      email: mwernimont@usgs.gov
      affiliation: U.S. Geological Survey
  twitter: "@USGS_R"
  required-packages:
    vizlab:
      repo: GRAN
      version: 0.1.7
    dataRetrieval:
      repo: CRAN
      version: 2.6.3
    sp:
      repo: CRAN
      version: 1.2-4
    maps:
      repo: CRAN
      version: 3.1.1
    maptools:
      repo: CRAN
      version: 0.9-1
    xml2:
      repo: CRAN
      version: 1.1.1
    rgeos:
      repo: CRAN
      version: 0.3.21
    stringr:
      repo: CRAN
      version: 1.2.0
    caTools:
      repo: CRAN
      version: 1.17.1
    gsplot:
      repo: GRAN
      version: 0.7.3
    svglite:
      repo: CRAN
      version: 1.2.0
fetch:
  -
    id: NM_data
    location: cache/NMdaily.rds
    fetcher: dv_data
    siteID: "08279500"
    refetch: FALSE
    reader: rds
    scripts: scripts/fetch/dv_data.R
  -
    id: disch-data
    location: cache/allSitesYears.csv
    fetcher: sciencebase
    refetch: false
    scripts:
    remoteItemId: 58c1c297e4b014cc3a3d3aa4 
    remoteFilename: allSitesYears_355.csv 
    mimetype: text/csv
  -
    id: siteText
    location: data/siteText.yaml
    scripts:
    reader: md
    mimetype: text/yaml
process:
  -
    id: disch-sites
    location: cache/disch-sites.rds
    processor: disch_sites
    scripts: scripts/process/disch_sites.R
    reader: rds
    depends: disch-data
  -
    id: state-map
    location: cache/state-map.rds
    processor: state_map
    scripts: scripts/process/process_map.R
    reader: rds
  - 
    id: processedNMdaily
    location: cache/processedNMdaily.rds
    processor: hydrographData
    scripts: scripts/process/hydrographs.R
    reader: rds
    depends: 
      dailyData: NM_data
  -
    id: watermark
    location: cache/watermark.rds
    processor: watermark
    scripts: scripts/process/process_usgs_watermark.R
    reader: rds
  - 
    id: site-map
    location: cache/site-map.rds
    processor: site_map
    scripts: scripts/process/process_map.R
    reader: rds
    depends: disch-sites
  - 
    id: year-data
    location: cache/year-data.json
    processor: year_json
    scripts: ["scripts/visualize/visualize-map.R", "scripts/process/process_year-json.R"]
    depends: ["site-map", "disch-data"]
    min-year: 1890
    max-year: 2015
    export: true
    mimetype: application/json
  - 
    id: bar-data
    location: cache/bar-data.xml
    processor: bar_chart
    scripts: ["scripts/process/process_bar_chart.R", "scripts/visualize/visualize-map.R"]
    depends: ["disch-data", "state-map"]
    reader: filepath
    min-year: 1890
    max-year: 2015
  -
    id: NMHydrograhTotal-svg
    location: cache/zoom-bar.xml
    processor: plot_hydrographTotal
    reader: filepath
    depends: 
      data: processedNMdaily
    height: 1
    width: 10
    full-desample: 30
    minYear: 1889
    maxYear: 2016
    scripts: scripts/process/process-hydrograph.R
visualize:
  -
    id: map-svg
    location: figures/states_map.svg
    visualizer: states_svg
    depends: ["state-map", "site-map", "watermark", "bar-data"]
    scripts: scripts/visualize/visualize-map.R
    mimetype: image/svg+xml
    inline: true
    title: "U.S. Geological Survey Active Stream Gages"
    alttext: "Map of U.S. Geological Survey gages"

  -
    id: doy-NM
    location: figures/doyNM.svg
    visualizer: doy
    mimetype: image/svg+xml
    inline: true
    height: 3
    width: 10
    full-desample: 5
    minYear: 1889
    maxYear: 2016
    depends: 
      daily: processedNMdaily
      zoomer: NMHydrograhTotal-svg
      watermark: watermark
    scripts: scripts/visualize/visualize-doy.R
    title: "NM through the ages"
    alttext: "NM gage"
  -
    id: thumbnail-map-facebook
    location: figures/thumb-facebook.png
    visualizer: map_thumbnail
    scripts: ["scripts/visualize/visualize-map.R"]
    depends: ["state-map", "site-map", "watermark", "bar-data"]
    fig-height: 820
    fig-width: 1560
    export: true
  -
    id: thumbnail-map-twitter
    location: figures/thumb-twitter.png
    visualizer: map_thumbnail
    scripts: ["scripts/visualize/visualize-map.R"]
    depends: ["state-map", "site-map", "watermark", "bar-data"]
    fig-height: 300
    fig-width: 560
    export: true
  -
    id: thumbnail-map-landing
    location: figures/thumb-landing.png
    visualizer: map_thumbnail
    scripts: ["scripts/visualize/visualize-map.R"]
    depends: ["state-map", "site-map", "watermark", "bar-data"]
    fig-height: 400
    fig-width: 400
    export: true
publish:
  -
    id: githubLogo
    location: images/github.svg
    mimetype: image/svg
    inline: true
    title: "Github"
    alttext: "Github Logo"
  -
    id: twitterLogo
    location: images/twitter.svg
    mimetype: image/svg
    inline: true
    title: "Twitter"
    alttext: "Twitter Logo"
  -
    id: facebookLogo
    location: images/facebook.svg
    mimetype: image/svg
    inline: true
    title: "Facebook"
    alttext: "Facebook Logo"
  -
    id: embedIcon
    location: images/embed.svg
    mimetype: image/svg
    inline: true
    title: "Embed"
    alttext: "Vizlab Embed Icon"
  -
    id: blackEmbedIcon
    location: images/blackEmbed.svg
    mimetype: image/svg
    inline: true
    title: "Embed"
    alttext: "Vizlab Embed Icon"
  -
    id: vizCSS
    location: layout/css/viz.css
    mimetype: text/css
    publisher: resource
  -
    id: svgCSS
    location: layout/css/svg.css
    mimetype: text/css
    publisher: resource
  -
    id: index
    name: index
    publisher: page
    template: fullpage
    depends:
      header: header
      footer: footer
      intro: intro
      map-section: map-section
      intro2: intro2
      doy-section: doy-section
      social-section: social-section
      embed-section: embed-section
      jquery: jquery-js
      svg-js: svg-js
      gages-js: gages-js
      year-data: year-data
      svgCSS: svgCSS
      vizCSS: vizCSS
      headerCSS: lib-header-css
      footerCSS: lib-footer-css
    context:
      header: header
      footer: footer
      sections: [ "intro", "map-section", "intro2", "doy-section", "social-section", "embed-section" ]
      resources: [ "jquery", "svg-js", "gages-js", "headerCSS", "footerCSS", "vizCSS", "svgCSS"]
  -
    id: intro
    template: layout/templates/intro.mustache
    publisher: section
    depends: siteText
    context:
      data: ["siteText.title", "siteText.introText1"]
  -
    id: map-section
    publisher: section
    template: layout/templates/figureTemplate.mustache
    depends:
      map: map-svg
      svg-js: svg-js
      gages-js: gages-js
      svgCSS: svgCSS
      siteText: siteText
    context:
      id: gage-map
      figure: map
      caption: siteText.explanationText1
  -
    id: intro2
    template: layout/templates/intro.mustache
    publisher: section
    depends: siteText
    context:
      data: siteText.introText2
  -
    id: doy-section
    publisher: section
    template: layout/templates/figureTemplate.mustache
    depends:
      siteText: siteText
      doyNM_graph: doy-NM
      svg-js: svg-js
      gages-js: gages-js
      svgCSS: svgCSS
    context:
      id: doyNM-graph
      figure: doyNM_graph
      caption: ["siteText.explanationText2", "siteText.dataSources"]
  -
    id: header
    publisher: section
    template: header-template
    context:
      title: Gages Through the Ages
  -
    id: social-section
    publisher: section
    template: layout/templates/socialMedia.mustache
    depends:
      githubLogo: githubLogo
      twitterLogo: twitterLogo 
      facebookLogo: facebookLogo
      embedIcon: embedIcon 
    context:
      githubLogo: githubLogo
      twitterLogo: twitterLogo 
      facebookLogo: facebookLogo
      embedIcon: embedIcon 
  -
    id: embed-section
    publisher: section
    template: layout/templates/embedTemplate.mustache
    depends:
      blackEmbedIcon: blackEmbedIcon
    context:
      blackEmbedIcon: blackEmbedIcon
      embeds: 
        -
          description: Embed Description Area
          url: "urltosweetplace"
  -
    id: footer
    publisher: footer
    template: footer-template
    blogsInFooter: TRUE
    vizzies:
      -
        org: USGS-VIZLAB
        repo: hurricane-matthew
    blogs:
      -
        name: Using the dataRetrieval Stats Service
        url: https://owi.usgs.gov/blog/stats-service-map/
        thumbLoc: https://owi.usgs.gov/blog/static/stats-service-map/plot-1.png
  -
    id: jquery-js
    location: layout/js/jquery311.min.js
    mimetype: text/javascript
  - 
    id: svg-js
    location: layout/js/svg.js
    mimetype: text/javascript
  -
    id: gages-js
    location: layout/js/gages.js
    mimetype: text/javascript
  -
    id: facebook-thumb
    location: figures/thumb-facebook.png
    publisher: thumbnail
    for: facebook
    mimetype: image/png
    export: TRUE
  -
    id: twitter-thumb
    location: figures/thumb-twitter.png
    publisher: thumbnail
    for: twitter
    mimetype: image/png
    export: TRUE
  -
    id: landing-thumb
    location: figures/thumb-landing.png
    publisher: thumbnail
    for: landing
    mimetype: image/png
    export: TRUE