viz.yaml

vizlab: "0.1.5"
info:
  id: example
  name: Simple but complete vizualization
  date: 2016-11-21
  publish-date: 9999-01-01
  path: /example
  analytics-id: UA-78530187-1
  description: >-
    This is meant to touch all features and act as an integration
    test of the vizlab platform.
  keywords: vizlab, visualizations, data, R
  twitter: "@USGS_R"
  owner:
    name: Alison Appling
    email: aappling@usgs.gov
    affiliation: U.S. Geological Survey
  contributors:
    -
      name: Jordan Walker
      email: jiwalker@usgs.gov
      affiliation: U.S. Geological Survey
    -
      name: Lindsay Carr
      email: lcarr@usgs.gov
      affiliation: U.S. Geological Survey
    -
      name: Samantha Oliver
      email: soliver@usgs.gov
      affiliation: U.S. Geological Survey
    -
      name: Jordan Read
      email: jread@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
    -
      name: Jacob Zwart
      email: jzwart@usgs.gov
      affiliation: U.S. Geological Survey
  required-packages:
    dplyr:
      repo: CRAN
      version: 0.7.2
    dataRetrieval:
      repo: GRAN
      version: 2.7.3
    vizlab:
      repo: github
      version: 0.2.2.9004
      name: USGS-VIZLAB/vizlab
      ref: 60fa3451555eea532c06c03f217ab46f0e28ff9a
    svglite: 
      repo: github
      version: 1.2.0.9003
      name: jread-usgs/svglite
      ref: svgnano_03
parameter:
  -
    id: plot-info
    height: 700
    width: 700
  -
    id: color-stuff
    points: green
  - 
    id: social-links
    github: https://github.com/USGS-VIZLAB/example
    twitter: https://twitter.com/share?url=https%3A%2F%2Fowi.usgs.gov%2Fvizlab%2FEXAMPLE%2F&text=EAMPLE1%20stuff&hashtags=EXAMPLE1,EXAMPLE2,dataviz
fetch:
  -
    id: iris-data
    location: data/iris.csv
    mimetype: text/csv
    scripts:
  -
    id: cars-data
    location: cache/cars.csv
    fetcher: cars
    mimetype: text/csv
    scripts: scripts/fetch/cars.R
  -
    id: Cuyahoga
    location: cache/fetch/CuyahogaTDS.csv
    fetcher: sciencebase
    scripts:
    remoteItemId: 59dffeb3e4b05fe04cce9fc2
    remoteFilename: CuyahogaTDS.csv
    mimetype: text/csv
  -
    id: markdown-text
    location: data/markdownText.yaml
    reader: md
    mimetype: text/yaml
process:
  -
    id: calc-cars
    location: cache/car-loess.rds
    processor: cars
    scripts: scripts/process/cars.R
    reader: rds
    depends: [ "cars-data" ]
  -
    id: CuyahogaShort
    location: cache/process/CuyahogaShort.tsv
    mimetype: text/tab-separated-values
    depends: Cuyahoga
    processor: cuyahoga
    scripts: scripts/process/cuyahoga.R
visualize:
  -
    id: plot-cars
    location: figures/cars.png
    scripts: scripts/visualize/visualize.R
    visualizer: cars
    depends: [ "calc-cars", "cars-data","plot-info" ]
    mimetype: image/png
    title: "Speed vs. Braking Distance"
    alttext: "plot of ratio of speed to braking distance"
  -
    id: plot-iris
    location: figures/iris.png
    scripts: scripts/visualize/visualize.R
    visualizer: iris
    depends: [ "iris-data" ]
    mimetype: image/png
    title: "Sepal length vs. pedal length"
    alttext: "plot of iris sepal length to pedal length"
  -
    id: cuyahogaFig
    location: figures/cuyahogaFig.svg
    depends:
      data: "CuyahogaShort"
      colors: "color-stuff"
    scripts: scripts/visualize/visualize.R
    visualizer: qTDS
    mimetype: image/svg+xml
    title: "Cuyahoga figure"
    alttext: "figure displaying total dissovled solids vs. discharge of Cuyahoga river"
  -
    id: coupla_dots
    location: figures/coupla_dots.svg
    scripts: scripts/visualize/visualize.R
    visualizer: dots
    mimetype: image/svg+xml
    title: "dots for testing interactions"
    alttext: "there is not much to look at here"
  -
    id: path
    location: figures/path.svg
    scripts: scripts/visualize/visualize.R
    visualizer: path
    mimetype: image/svg+xml
    title: "path for testing interactions"
    alttext: "there is not much to look at here"
publish:
  -
    id: index
    name: index
    publisher: page
    template: fullpage
    depends: 
      sourcesansprofont: sourcesansprofont
      cars-section: cars-section
      dots_section: dots_section
      path_section: path_section
      social: social-section
      vertical-social: vertical-social-section
      footer: footer-section
      header: header-section
      figure-style: figure-style
      text-section: text-section
      iris-section: iris-section
      Cuyahoga-section: Cuyahoga-section
      markdown-section1: markdown-section1
      markdown-section2: markdown-section2
      footerCSS: lib-footer-css
      headerCSS: lib-header-css
      svgCSS: svg-css
      socialCSS: lib-social-media-css
      jquery: lib-jquery-js
      svg-inject: lib-svg-injector-js
      vizlabjs: lib-vizlab-javascript
      lib-d3-js: lib-d3-js
      tooltip-js: lib-tooltip-js
      thumb-twitter: thumb-twitter
      thumb-facebook: thumb-facebook
      thumb-landing: thumb-landing
    context:
      title: Testing
      sections: [ "vertical-social", "cars-section", "dots_section", "path_section", "social", "text-section", "iris-section", "markdown-section1", "Cuyahoga-section", "markdown-section2"]
      resources: [ "figure-style", "footerCSS", "headerCSS", "svgCSS","socialCSS", "sourcesansprofont","jquery", "svg-inject", "vizlabjs", "lib-d3-js", "tooltip-js"]
      thumbnails: 
        twitter: thumb-twitter
        facebook: thumb-facebook
        landing: thumb-landing
        main: thumb-landing
  -
    id: cars-section
    publisher: section
    template: simplefigure
    depends: [ "plot-cars" ]
    context:
      id: carsFig
      figure: "plot-cars"
      caption: Relationship between speed and stopping distance on several cars
  -
    id: dots_section
    publisher: section
    template: simplefigure
    depends: [ "coupla_dots" ]
    context:
      id: svg-dots
      figure: "coupla_dots"
      caption: dots that are svg elements
  -
    id: path_section
    publisher: section
    template: simplefigure
    depends: [ "path" ]
    context:
      id: svg-path
      figure: "path"
      caption: path svg elements
  -
    id: text-section
    template: printall
    publisher: section
    context:
      text:
        This is a text section in the viz.yaml.  Since it is only
        text, it doesn't need be referenced anywhere outside of the publish
        section.  Text wrapping in the viz should be handled automatically.
        Follow YAML conventions to change formatting.
  -
    id: markdown-section1
    template: printall
    publisher: section
    depends: markdown-text
    context:
      text: markdown-text.example-markdown
  -
    id: markdown-section2
    template: printall
    publisher: section
    depends: markdown-text
    context:
      text: markdown-text.markdown-table
  -
    id: iris-section
    publisher: section
    template: simplefigure
    depends: [ "plot-iris" ]
    context:
      id: irisFig
      figure: "plot-iris"
      caption: Relationship between iris sepal length to pedal length
  -
    id: Cuyahoga-section
    template: simplefigure
    depends: cuyahogaFig
    publisher: section
    context:
      id: cuyahoga-fig
      figure: cuyahogaFig
      caption: Total dissolved solids vs discharge
  -
    id: embed-page
    name: embed-dots
    publisher: page
    template: embed
    mimetype: text/html
    depends: ["dots_section", "svg-css", "lib-jquery-js", "lib-d3-js","lib-tooltip-js"]
    context:
      resources: ["svg-css", "lib-jquery-js", "lib-svg-injector-js", "lib-vizlab-javascript","lib-vizlab-favicon", "lib-d3-js","lib-tooltip-js"]
      embed: ["dots_section"]
  -
    id: figure-style
    location: layout/css/main.css
    publisher: resource
    mimetype: text/css
  -
    id: social-section
    template: social-media-template
    publisher: social
    depends: social-links
    context:
      embedLink: embed-dots.html
      facebookLink: http://www.facebook.com/sharer.php?u=https%3A%2F%2Fowi.usgs.gov%2Fvizlab%2FEXAMPLE%2F
  -
    id: vertical-social-section
    template: vertical-social-media-template
    publisher: social
    depends: social-links
    context: 
      embedLink: embed-dots.html
      facebookLink: http://www.facebook.com/sharer.php?u=https%3A%2F%2Fowi.usgs.gov%2Fvizlab%2FEXAMPLE%2F
  -
    id: header-section
    template: header-template
    publisher: header
    context:
      title: Example Viz
  -
    id: footer-section
    template: footer-template
    publisher: footer
    depends: [ "lib-footer-css"]
    blogsInFooter: TRUE
    vizzies:
      - name: Drought in the Lower Colorado Basin
        org: USGS-CIDA
        repo: OWDI-Lower-Colorado-Drought-Vis
      - name: Microplastics in the Great Lakes
        url: https://owi.usgs.gov/vizlab/microplastics/
        thumbLoc: https://owi.usgs.gov/vizlab/microplastics/images/thumbnail.png
    blogs:
      - name: Visualizing Tropical Storm Colin Precipitation using geoknife
        org: https://owi.usgs.gov/blog/ts-colin-precip/
        thumbLoc: https://owi.usgs.gov/blog/static/ts-colin-precip/use-functions-1.png
  -
    id: sourcesansprofont
    publisher: googlefont
    family: "Source Sans Pro"
    weight: [300, 400, 600]
  -
    id: svg-css
    location: layout/css/svg.css
    mimetype: text/css
    publisher: resource
  -
    id: thumb-facebook
    location: images/thumb-facebook.png
    publisher: thumbnail
    mimetype: image/png
    thumbType: facebook
    title: "Facebook Thumbnail"
    alttext: "Facebook Thumbnail"
  -
    id: thumb-twitter
    location: images/thumb-twitter.png
    publisher: thumbnail
    thumbType: twitter
    mimetype: image/png
    title: "Twitter Thumbnail"
    alttext: "Twitter Thumbnail"
  -
    id: thumb-landing
    location: images/thumb-landing.png
    publisher: thumbnail
    mimetype: image/png
    thumbType: [landing, main]
    title: "Landing Thumbnail"
    alttext: "Landing Thumbnail"