From 6c93246e6f78e44635a8b079a4b9e743347c06fb Mon Sep 17 00:00:00 2001 From: Matt Dancho Date: Sat, 20 Mar 2021 07:23:52 -0400 Subject: [PATCH] initial pkgdown --- .Rbuildignore | 3 + .gitignore | 1 + _pkgdown.yml | 0 docs/404.html | 155 ++++++++ docs/LICENSE-text.html | 157 ++++++++ docs/LICENSE.html | 161 ++++++++ docs/articles/getting-started.html | 115 ++++++ .../header-attrs-2.7/header-attrs.js | 12 + docs/articles/index.html | 154 ++++++++ docs/authors.html | 154 ++++++++ docs/bootstrap-toc.css | 60 +++ docs/bootstrap-toc.js | 159 ++++++++ docs/docsearch.css | 148 +++++++ docs/docsearch.js | 85 ++++ docs/index.html | 128 ++++++ docs/link.svg | 12 + docs/news/index.html | 160 ++++++++ docs/pkgdown.css | 367 ++++++++++++++++++ docs/pkgdown.js | 108 ++++++ docs/pkgdown.yml | 7 + docs/reference/figures/README-pressure-1.png | Bin 0 -> 22985 bytes docs/reference/index.html | 161 ++++++++ docs/reference/pipe.html | 176 +++++++++ docs/reference/tidyeval.html | 224 +++++++++++ 24 files changed, 2707 insertions(+) create mode 100644 _pkgdown.yml create mode 100644 docs/404.html create mode 100644 docs/LICENSE-text.html create mode 100644 docs/LICENSE.html create mode 100644 docs/articles/getting-started.html create mode 100644 docs/articles/getting-started_files/header-attrs-2.7/header-attrs.js create mode 100644 docs/articles/index.html create mode 100644 docs/authors.html create mode 100644 docs/bootstrap-toc.css create mode 100644 docs/bootstrap-toc.js create mode 100644 docs/docsearch.css create mode 100644 docs/docsearch.js create mode 100644 docs/index.html create mode 100644 docs/link.svg create mode 100644 docs/news/index.html create mode 100644 docs/pkgdown.css create mode 100644 docs/pkgdown.js create mode 100644 docs/pkgdown.yml create mode 100644 docs/reference/figures/README-pressure-1.png create mode 100644 docs/reference/index.html create mode 100644 docs/reference/pipe.html create mode 100644 docs/reference/tidyeval.html diff --git a/.Rbuildignore b/.Rbuildignore index b4c6842..eb780d9 100644 --- a/.Rbuildignore +++ b/.Rbuildignore @@ -2,3 +2,6 @@ ^README\.Rmd$ ^.*\.Rproj$ ^\.Rproj\.user$ +^_pkgdown\.yml$ +^docs$ +^pkgdown$ diff --git a/.gitignore b/.gitignore index c833a2c..364bd93 100644 --- a/.gitignore +++ b/.gitignore @@ -3,3 +3,4 @@ .RData .Ruserdata inst/doc + diff --git a/_pkgdown.yml b/_pkgdown.yml new file mode 100644 index 0000000..e69de29 diff --git a/docs/404.html b/docs/404.html new file mode 100644 index 0000000..d7d5263 --- /dev/null +++ b/docs/404.html @@ -0,0 +1,155 @@ + + + + + + + + +Page not found (404) • gamsnip + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + + + +
+ +
+
+
+

Page not found (404)

+
+ +Content not found. Please use links in the navbar. + +
+ + + +
+ + + +
+
+

Developed by First Last.

+
+ +
+

Site built with pkgdown 1.6.1.

+
+ +
+
+ + + + + + + + diff --git a/docs/LICENSE-text.html b/docs/LICENSE-text.html new file mode 100644 index 0000000..aedfd32 --- /dev/null +++ b/docs/LICENSE-text.html @@ -0,0 +1,157 @@ + + + + + + + + +License • gamsnip + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + + + +
+ +
+
+
+

License

+
+ +
YEAR: 2021
+COPYRIGHT HOLDER: BUSINESS SCIENCE
+
+ +
+ + + +
+ + + +
+
+

Developed by First Last.

+
+ +
+

Site built with pkgdown 1.6.1.

+
+ +
+
+ + + + + + + + diff --git a/docs/LICENSE.html b/docs/LICENSE.html new file mode 100644 index 0000000..8bea1fe --- /dev/null +++ b/docs/LICENSE.html @@ -0,0 +1,161 @@ + + + + + + + + +MIT License • gamsnip + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + + + +
+ +
+
+
+

MIT License

+
+ +
+ +

Copyright (c) 2021 BUSINESS SCIENCE

+

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

+

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

+

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

+
+ +
+ + + +
+ + + +
+
+

Developed by First Last.

+
+ +
+

Site built with pkgdown 1.6.1.

+
+ +
+
+ + + + + + + + diff --git a/docs/articles/getting-started.html b/docs/articles/getting-started.html new file mode 100644 index 0000000..9f00626 --- /dev/null +++ b/docs/articles/getting-started.html @@ -0,0 +1,115 @@ + + + + + + + +Getting Started with gamsnip • gamsnip + + + + + + + + + + +
+
+ + + + +
+
+
+

Getting Started with gamsnip

+ + + + + +
+ + + +
+library(gamsnip)
+
+ + + +
+ + + +
+

Developed by First Last.

+
+ +
+

Site built with pkgdown 1.6.1.

+
+ +
+
+ + + + + + diff --git a/docs/articles/getting-started_files/header-attrs-2.7/header-attrs.js b/docs/articles/getting-started_files/header-attrs-2.7/header-attrs.js new file mode 100644 index 0000000..dd57d92 --- /dev/null +++ b/docs/articles/getting-started_files/header-attrs-2.7/header-attrs.js @@ -0,0 +1,12 @@ +// Pandoc 2.9 adds attributes on both header and div. We remove the former (to +// be compatible with the behavior of Pandoc < 2.8). +document.addEventListener('DOMContentLoaded', function(e) { + var hs = document.querySelectorAll("div.section[class*='level'] > :first-child"); + var i, h, a; + for (i = 0; i < hs.length; i++) { + h = hs[i]; + if (!/^h[1-6]$/i.test(h.tagName)) continue; // it should be a header h1-h6 + a = h.attributes; + while (a.length > 0) h.removeAttribute(a[0].name); + } +}); diff --git a/docs/articles/index.html b/docs/articles/index.html new file mode 100644 index 0000000..562cadc --- /dev/null +++ b/docs/articles/index.html @@ -0,0 +1,154 @@ + + + + + + + + +Articles • gamsnip + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + + + +
+ +
+
+
+

Articles

+
+ +
+

All vignettes

+

+ +
+
Getting Started with gamsnip
+
+
+
+
+
+ + +
+
+

Developed by First Last.

+
+ +
+

Site built with pkgdown 1.6.1.

+
+ +
+
+ + + + + + + + diff --git a/docs/authors.html b/docs/authors.html new file mode 100644 index 0000000..4130133 --- /dev/null +++ b/docs/authors.html @@ -0,0 +1,154 @@ + + + + + + + + +Authors • gamsnip + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + + + +
+ +
+
+
+

Authors

+
+ +
    +
  • +

    First Last. Author, maintainer. +

    +
    • +
+ +
+ +
+ + + +
+
+

Developed by First Last.

+
+ +
+

Site built with pkgdown 1.6.1.

+
+ +
+
+ + + + + + + + diff --git a/docs/bootstrap-toc.css b/docs/bootstrap-toc.css new file mode 100644 index 0000000..5a85941 --- /dev/null +++ b/docs/bootstrap-toc.css @@ -0,0 +1,60 @@ +/*! + * Bootstrap Table of Contents v0.4.1 (http://afeld.github.io/bootstrap-toc/) + * Copyright 2015 Aidan Feldman + * Licensed under MIT (https://github.com/afeld/bootstrap-toc/blob/gh-pages/LICENSE.md) */ + +/* modified from https://github.com/twbs/bootstrap/blob/94b4076dd2efba9af71f0b18d4ee4b163aa9e0dd/docs/assets/css/src/docs.css#L548-L601 */ + +/* All levels of nav */ +nav[data-toggle='toc'] .nav > li > a { + display: block; + padding: 4px 20px; + font-size: 13px; + font-weight: 500; + color: #767676; +} +nav[data-toggle='toc'] .nav > li > a:hover, +nav[data-toggle='toc'] .nav > li > a:focus { + padding-left: 19px; + color: #563d7c; + text-decoration: none; + background-color: transparent; + border-left: 1px solid #563d7c; +} +nav[data-toggle='toc'] .nav > .active > a, +nav[data-toggle='toc'] .nav > .active:hover > a, +nav[data-toggle='toc'] .nav > .active:focus > a { + padding-left: 18px; + font-weight: bold; + color: #563d7c; + background-color: transparent; + border-left: 2px solid #563d7c; +} + +/* Nav: second level (shown on .active) */ +nav[data-toggle='toc'] .nav .nav { + display: none; /* Hide by default, but at >768px, show it */ + padding-bottom: 10px; +} +nav[data-toggle='toc'] .nav .nav > li > a { + padding-top: 1px; + padding-bottom: 1px; + padding-left: 30px; + font-size: 12px; + font-weight: normal; +} +nav[data-toggle='toc'] .nav .nav > li > a:hover, +nav[data-toggle='toc'] .nav .nav > li > a:focus { + padding-left: 29px; +} +nav[data-toggle='toc'] .nav .nav > .active > a, +nav[data-toggle='toc'] .nav .nav > .active:hover > a, +nav[data-toggle='toc'] .nav .nav > .active:focus > a { + padding-left: 28px; + font-weight: 500; +} + +/* from https://github.com/twbs/bootstrap/blob/e38f066d8c203c3e032da0ff23cd2d6098ee2dd6/docs/assets/css/src/docs.css#L631-L634 */ +nav[data-toggle='toc'] .nav > .active > ul { + display: block; +} diff --git a/docs/bootstrap-toc.js b/docs/bootstrap-toc.js new file mode 100644 index 0000000..1cdd573 --- /dev/null +++ b/docs/bootstrap-toc.js @@ -0,0 +1,159 @@ +/*! + * Bootstrap Table of Contents v0.4.1 (http://afeld.github.io/bootstrap-toc/) + * Copyright 2015 Aidan Feldman + * Licensed under MIT (https://github.com/afeld/bootstrap-toc/blob/gh-pages/LICENSE.md) */ +(function() { + 'use strict'; + + window.Toc = { + helpers: { + // return all matching elements in the set, or their descendants + findOrFilter: function($el, selector) { + // http://danielnouri.org/notes/2011/03/14/a-jquery-find-that-also-finds-the-root-element/ + // http://stackoverflow.com/a/12731439/358804 + var $descendants = $el.find(selector); + return $el.filter(selector).add($descendants).filter(':not([data-toc-skip])'); + }, + + generateUniqueIdBase: function(el) { + var text = $(el).text(); + var anchor = text.trim().toLowerCase().replace(/[^A-Za-z0-9]+/g, '-'); + return anchor || el.tagName.toLowerCase(); + }, + + generateUniqueId: function(el) { + var anchorBase = this.generateUniqueIdBase(el); + for (var i = 0; ; i++) { + var anchor = anchorBase; + if (i > 0) { + // add suffix + anchor += '-' + i; + } + // check if ID already exists + if (!document.getElementById(anchor)) { + return anchor; + } + } + }, + + generateAnchor: function(el) { + if (el.id) { + return el.id; + } else { + var anchor = this.generateUniqueId(el); + el.id = anchor; + return anchor; + } + }, + + createNavList: function() { + return $(''); + }, + + createChildNavList: function($parent) { + var $childList = this.createNavList(); + $parent.append($childList); + return $childList; + }, + + generateNavEl: function(anchor, text) { + var $a = $(''); + $a.attr('href', '#' + anchor); + $a.text(text); + var $li = $('
  • '); + $li.append($a); + return $li; + }, + + generateNavItem: function(headingEl) { + var anchor = this.generateAnchor(headingEl); + var $heading = $(headingEl); + var text = $heading.data('toc-text') || $heading.text(); + return this.generateNavEl(anchor, text); + }, + + // Find the first heading level (`

    `, then `

    `, etc.) that has more than one element. Defaults to 1 (for `

    `). + getTopLevel: function($scope) { + for (var i = 1; i <= 6; i++) { + var $headings = this.findOrFilter($scope, 'h' + i); + if ($headings.length > 1) { + return i; + } + } + + return 1; + }, + + // returns the elements for the top level, and the next below it + getHeadings: function($scope, topLevel) { + var topSelector = 'h' + topLevel; + + var secondaryLevel = topLevel + 1; + var secondarySelector = 'h' + secondaryLevel; + + return this.findOrFilter($scope, topSelector + ',' + secondarySelector); + }, + + getNavLevel: function(el) { + return parseInt(el.tagName.charAt(1), 10); + }, + + populateNav: function($topContext, topLevel, $headings) { + var $context = $topContext; + var $prevNav; + + var helpers = this; + $headings.each(function(i, el) { + var $newNav = helpers.generateNavItem(el); + var navLevel = helpers.getNavLevel(el); + + // determine the proper $context + if (navLevel === topLevel) { + // use top level + $context = $topContext; + } else if ($prevNav && $context === $topContext) { + // create a new level of the tree and switch to it + $context = helpers.createChildNavList($prevNav); + } // else use the current $context + + $context.append($newNav); + + $prevNav = $newNav; + }); + }, + + parseOps: function(arg) { + var opts; + if (arg.jquery) { + opts = { + $nav: arg + }; + } else { + opts = arg; + } + opts.$scope = opts.$scope || $(document.body); + return opts; + } + }, + + // accepts a jQuery object, or an options object + init: function(opts) { + opts = this.helpers.parseOps(opts); + + // ensure that the data attribute is in place for styling + opts.$nav.attr('data-toggle', 'toc'); + + var $topContext = this.helpers.createChildNavList(opts.$nav); + var topLevel = this.helpers.getTopLevel(opts.$scope); + var $headings = this.helpers.getHeadings(opts.$scope, topLevel); + this.helpers.populateNav($topContext, topLevel, $headings); + } + }; + + $(function() { + $('nav[data-toggle="toc"]').each(function(i, el) { + var $nav = $(el); + Toc.init($nav); + }); + }); +})(); diff --git a/docs/docsearch.css b/docs/docsearch.css new file mode 100644 index 0000000..e5f1fe1 --- /dev/null +++ b/docs/docsearch.css @@ -0,0 +1,148 @@ +/* Docsearch -------------------------------------------------------------- */ +/* + Source: https://github.com/algolia/docsearch/ + License: MIT +*/ + +.algolia-autocomplete { + display: block; + -webkit-box-flex: 1; + -ms-flex: 1; + flex: 1 +} + +.algolia-autocomplete .ds-dropdown-menu { + width: 100%; + min-width: none; + max-width: none; + padding: .75rem 0; + background-color: #fff; + background-clip: padding-box; + border: 1px solid rgba(0, 0, 0, .1); + box-shadow: 0 .5rem 1rem rgba(0, 0, 0, .175); +} + +@media (min-width:768px) { + .algolia-autocomplete .ds-dropdown-menu { + width: 175% + } +} + +.algolia-autocomplete .ds-dropdown-menu::before { + display: none +} + +.algolia-autocomplete .ds-dropdown-menu [class^=ds-dataset-] { + padding: 0; + background-color: rgb(255,255,255); + border: 0; + max-height: 80vh; +} + +.algolia-autocomplete .ds-dropdown-menu .ds-suggestions { + margin-top: 0 +} + +.algolia-autocomplete .algolia-docsearch-suggestion { + padding: 0; + overflow: visible +} + +.algolia-autocomplete .algolia-docsearch-suggestion--category-header { + padding: .125rem 1rem; + margin-top: 0; + font-size: 1.3em; + font-weight: 500; + color: #00008B; + border-bottom: 0 +} + +.algolia-autocomplete .algolia-docsearch-suggestion--wrapper { + float: none; + padding-top: 0 +} + +.algolia-autocomplete .algolia-docsearch-suggestion--subcategory-column { + float: none; + width: auto; + padding: 0; + text-align: left +} + +.algolia-autocomplete .algolia-docsearch-suggestion--content { + float: none; + width: auto; + padding: 0 +} + +.algolia-autocomplete .algolia-docsearch-suggestion--content::before { + display: none +} + +.algolia-autocomplete .ds-suggestion:not(:first-child) .algolia-docsearch-suggestion--category-header { + padding-top: .75rem; + margin-top: .75rem; + border-top: 1px solid rgba(0, 0, 0, .1) +} + +.algolia-autocomplete .ds-suggestion .algolia-docsearch-suggestion--subcategory-column { + display: block; + padding: .1rem 1rem; + margin-bottom: 0.1; + font-size: 1.0em; + font-weight: 400 + /* display: none */ +} + +.algolia-autocomplete .algolia-docsearch-suggestion--title { + display: block; + padding: .25rem 1rem; + margin-bottom: 0; + font-size: 0.9em; + font-weight: 400 +} + +.algolia-autocomplete .algolia-docsearch-suggestion--text { + padding: 0 1rem .5rem; + margin-top: -.25rem; + font-size: 0.8em; + font-weight: 400; + line-height: 1.25 +} + +.algolia-autocomplete .algolia-docsearch-footer { + width: 110px; + height: 20px; + z-index: 3; + margin-top: 10.66667px; + float: right; + font-size: 0; + line-height: 0; +} + +.algolia-autocomplete .algolia-docsearch-footer--logo { + background-image: url("data:image/svg+xml;utf8,"); + background-repeat: no-repeat; + background-position: 50%; + background-size: 100%; + overflow: hidden; + text-indent: -9000px; + width: 100%; + height: 100%; + display: block; + transform: translate(-8px); +} + +.algolia-autocomplete .algolia-docsearch-suggestion--highlight { + color: #FF8C00; + background: rgba(232, 189, 54, 0.1) +} + + +.algolia-autocomplete .algolia-docsearch-suggestion--text .algolia-docsearch-suggestion--highlight { + box-shadow: inset 0 -2px 0 0 rgba(105, 105, 105, .5) +} + +.algolia-autocomplete .ds-suggestion.ds-cursor .algolia-docsearch-suggestion--content { + background-color: rgba(192, 192, 192, .15) +} diff --git a/docs/docsearch.js b/docs/docsearch.js new file mode 100644 index 0000000..b35504c --- /dev/null +++ b/docs/docsearch.js @@ -0,0 +1,85 @@ +$(function() { + + // register a handler to move the focus to the search bar + // upon pressing shift + "/" (i.e. "?") + $(document).on('keydown', function(e) { + if (e.shiftKey && e.keyCode == 191) { + e.preventDefault(); + $("#search-input").focus(); + } + }); + + $(document).ready(function() { + // do keyword highlighting + /* modified from https://jsfiddle.net/julmot/bL6bb5oo/ */ + var mark = function() { + + var referrer = document.URL ; + var paramKey = "q" ; + + if (referrer.indexOf("?") !== -1) { + var qs = referrer.substr(referrer.indexOf('?') + 1); + var qs_noanchor = qs.split('#')[0]; + var qsa = qs_noanchor.split('&'); + var keyword = ""; + + for (var i = 0; i < qsa.length; i++) { + var currentParam = qsa[i].split('='); + + if (currentParam.length !== 2) { + continue; + } + + if (currentParam[0] == paramKey) { + keyword = decodeURIComponent(currentParam[1].replace(/\+/g, "%20")); + } + } + + if (keyword !== "") { + $(".contents").unmark({ + done: function() { + $(".contents").mark(keyword); + } + }); + } + } + }; + + mark(); + }); +}); + +/* Search term highlighting ------------------------------*/ + +function matchedWords(hit) { + var words = []; + + var hierarchy = hit._highlightResult.hierarchy; + // loop to fetch from lvl0, lvl1, etc. + for (var idx in hierarchy) { + words = words.concat(hierarchy[idx].matchedWords); + } + + var content = hit._highlightResult.content; + if (content) { + words = words.concat(content.matchedWords); + } + + // return unique words + var words_uniq = [...new Set(words)]; + return words_uniq; +} + +function updateHitURL(hit) { + + var words = matchedWords(hit); + var url = ""; + + if (hit.anchor) { + url = hit.url_without_anchor + '?q=' + escape(words.join(" ")) + '#' + hit.anchor; + } else { + url = hit.url + '?q=' + escape(words.join(" ")); + } + + return url; +} diff --git a/docs/index.html b/docs/index.html new file mode 100644 index 0000000..281cac6 --- /dev/null +++ b/docs/index.html @@ -0,0 +1,128 @@ + + + + + + + +What the Package Does (One Line, Title Case) • gamsnip + + + + + + + + + + +
    +
    + + + + +
    +
    +
    +

    +gamsnip

    + + +

    The goal of gamsnip is to …

    +
    +

    +Installation

    +

    Development version:

    +
    +# install.packages("devtools")
+devtools::install_github("business-science/gamsnip")
    +
    +
    +
    + + +
    + + +
    +

    Developed by First Last.

    +
    + +
    +

    Site built with pkgdown 1.6.1.

    +
    + +
    +
    + + + + + + diff --git a/docs/link.svg b/docs/link.svg new file mode 100644 index 0000000..88ad827 --- /dev/null +++ b/docs/link.svg @@ -0,0 +1,12 @@ + + + + + + diff --git a/docs/news/index.html b/docs/news/index.html new file mode 100644 index 0000000..8d8b8fc --- /dev/null +++ b/docs/news/index.html @@ -0,0 +1,160 @@ + + + + + + + + +Changelog • gamsnip + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    + + + + +
    + +
    +
    +
    +

    Changelog

    + +
    + +
    +

    +gamsnip 0.0.0.9000

    +
      +
    • Added a NEWS.md file to track changes to the package.
      • +
    +
    +
    + + + +
    + + +
    +
    +

    Developed by First Last.

    +
    + +
    +

    Site built with pkgdown 1.6.1.

    +
    + +
    +
    + + + + + + + + diff --git a/docs/pkgdown.css b/docs/pkgdown.css new file mode 100644 index 0000000..1273238 --- /dev/null +++ b/docs/pkgdown.css @@ -0,0 +1,367 @@ +/* Sticky footer */ + +/** + * Basic idea: https://philipwalton.github.io/solved-by-flexbox/demos/sticky-footer/ + * Details: https://github.com/philipwalton/solved-by-flexbox/blob/master/assets/css/components/site.css + * + * .Site -> body > .container + * .Site-content -> body > .container .row + * .footer -> footer + * + * Key idea seems to be to ensure that .container and __all its parents__ + * have height set to 100% + * + */ + +html, body { + height: 100%; +} + +body { + position: relative; +} + +body > .container { + display: flex; + height: 100%; + flex-direction: column; +} + +body > .container .row { + flex: 1 0 auto; +} + +footer { + margin-top: 45px; + padding: 35px 0 36px; + border-top: 1px solid #e5e5e5; + color: #666; + display: flex; + flex-shrink: 0; +} +footer p { + margin-bottom: 0; +} +footer div { + flex: 1; +} +footer .pkgdown { + text-align: right; +} +footer p { + margin-bottom: 0; +} + +img.icon { + float: right; +} + +img { + max-width: 100%; +} + +/* Fix bug in bootstrap (only seen in firefox) */ +summary { + display: list-item; +} + +/* Typographic tweaking ---------------------------------*/ + +.contents .page-header { + margin-top: calc(-60px + 1em); +} + +dd { + margin-left: 3em; +} + +/* Section anchors ---------------------------------*/ + +a.anchor { + margin-left: -30px; + display:inline-block; + width: 30px; + height: 30px; + visibility: hidden; + + background-image: url(./link.svg); + background-repeat: no-repeat; + background-size: 20px 20px; + background-position: center center; +} + +.hasAnchor:hover a.anchor { + visibility: visible; +} + +@media (max-width: 767px) { + .hasAnchor:hover a.anchor { + visibility: hidden; + } +} + + +/* Fixes for fixed navbar --------------------------*/ + +.contents h1, .contents h2, .contents h3, .contents h4 { + padding-top: 60px; + margin-top: -40px; +} + +/* Navbar submenu --------------------------*/ + +.dropdown-submenu { + position: relative; +} + +.dropdown-submenu>.dropdown-menu { + top: 0; + left: 100%; + margin-top: -6px; + margin-left: -1px; + border-radius: 0 6px 6px 6px; +} + +.dropdown-submenu:hover>.dropdown-menu { + display: block; +} + +.dropdown-submenu>a:after { + display: block; + content: " "; + float: right; + width: 0; + height: 0; + border-color: transparent; + border-style: solid; + border-width: 5px 0 5px 5px; + border-left-color: #cccccc; + margin-top: 5px; + margin-right: -10px; +} + +.dropdown-submenu:hover>a:after { + border-left-color: #ffffff; +} + +.dropdown-submenu.pull-left { + float: none; +} + +.dropdown-submenu.pull-left>.dropdown-menu { + left: -100%; + margin-left: 10px; + border-radius: 6px 0 6px 6px; +} + +/* Sidebar --------------------------*/ + +#pkgdown-sidebar { + margin-top: 30px; + position: -webkit-sticky; + position: sticky; + top: 70px; +} + +#pkgdown-sidebar h2 { + font-size: 1.5em; + margin-top: 1em; +} + +#pkgdown-sidebar h2:first-child { + margin-top: 0; +} + +#pkgdown-sidebar .list-unstyled li { + margin-bottom: 0.5em; +} + +/* bootstrap-toc tweaks ------------------------------------------------------*/ + +/* All levels of nav */ + +nav[data-toggle='toc'] .nav > li > a { + padding: 4px 20px 4px 6px; + font-size: 1.5rem; + font-weight: 400; + color: inherit; +} + +nav[data-toggle='toc'] .nav > li > a:hover, +nav[data-toggle='toc'] .nav > li > a:focus { + padding-left: 5px; + color: inherit; + border-left: 1px solid #878787; +} + +nav[data-toggle='toc'] .nav > .active > a, +nav[data-toggle='toc'] .nav > .active:hover > a, +nav[data-toggle='toc'] .nav > .active:focus > a { + padding-left: 5px; + font-size: 1.5rem; + font-weight: 400; + color: inherit; + border-left: 2px solid #878787; +} + +/* Nav: second level (shown on .active) */ + +nav[data-toggle='toc'] .nav .nav { + display: none; /* Hide by default, but at >768px, show it */ + padding-bottom: 10px; +} + +nav[data-toggle='toc'] .nav .nav > li > a { + padding-left: 16px; + font-size: 1.35rem; +} + +nav[data-toggle='toc'] .nav .nav > li > a:hover, +nav[data-toggle='toc'] .nav .nav > li > a:focus { + padding-left: 15px; +} + +nav[data-toggle='toc'] .nav .nav > .active > a, +nav[data-toggle='toc'] .nav .nav > .active:hover > a, +nav[data-toggle='toc'] .nav .nav > .active:focus > a { + padding-left: 15px; + font-weight: 500; + font-size: 1.35rem; +} + +/* orcid ------------------------------------------------------------------- */ + +.orcid { + font-size: 16px; + color: #A6CE39; + /* margins are required by official ORCID trademark and display guidelines */ + margin-left:4px; + margin-right:4px; + vertical-align: middle; +} + +/* Reference index & topics ----------------------------------------------- */ + +.ref-index th {font-weight: normal;} + +.ref-index td {vertical-align: top; min-width: 100px} +.ref-index .icon {width: 40px;} +.ref-index .alias {width: 40%;} +.ref-index-icons .alias {width: calc(40% - 40px);} +.ref-index .title {width: 60%;} + +.ref-arguments th {text-align: right; padding-right: 10px;} +.ref-arguments th, .ref-arguments td {vertical-align: top; min-width: 100px} +.ref-arguments .name {width: 20%;} +.ref-arguments .desc {width: 80%;} + +/* Nice scrolling for wide elements --------------------------------------- */ + +table { + display: block; + overflow: auto; +} + +/* Syntax highlighting ---------------------------------------------------- */ + +pre { + word-wrap: normal; + word-break: normal; + border: 1px solid #eee; +} + +pre, code { + background-color: #f8f8f8; + color: #333; +} + +pre code { + overflow: auto; + word-wrap: normal; + white-space: pre; +} + +pre .img { + margin: 5px 0; +} + +pre .img img { + background-color: #fff; + display: block; + height: auto; +} + +code a, pre a { + color: #375f84; +} + +a.sourceLine:hover { + text-decoration: none; +} + +.fl {color: #1514b5;} +.fu {color: #000000;} /* function */ +.ch,.st {color: #036a07;} /* string */ +.kw {color: #264D66;} /* keyword */ +.co {color: #888888;} /* comment */ + +.message { color: black; font-weight: bolder;} +.error { color: orange; font-weight: bolder;} +.warning { color: #6A0366; font-weight: bolder;} + +/* Clipboard --------------------------*/ + +.hasCopyButton { + position: relative; +} + +.btn-copy-ex { + position: absolute; + right: 0; + top: 0; + visibility: hidden; +} + +.hasCopyButton:hover button.btn-copy-ex { + visibility: visible; +} + +/* headroom.js ------------------------ */ + +.headroom { + will-change: transform; + transition: transform 200ms linear; +} +.headroom--pinned { + transform: translateY(0%); +} +.headroom--unpinned { + transform: translateY(-100%); +} + +/* mark.js ----------------------------*/ + +mark { + background-color: rgba(255, 255, 51, 0.5); + border-bottom: 2px solid rgba(255, 153, 51, 0.3); + padding: 1px; +} + +/* vertical spacing after htmlwidgets */ +.html-widget { + margin-bottom: 10px; +} + +/* fontawesome ------------------------ */ + +.fab { + font-family: "Font Awesome 5 Brands" !important; +} + +/* don't display links in code chunks when printing */ +/* source: https://stackoverflow.com/a/10781533 */ +@media print { + code a:link:after, code a:visited:after { + content: ""; + } +} diff --git a/docs/pkgdown.js b/docs/pkgdown.js new file mode 100644 index 0000000..7e7048f --- /dev/null +++ b/docs/pkgdown.js @@ -0,0 +1,108 @@ +/* http://gregfranko.com/blog/jquery-best-practices/ */ +(function($) { + $(function() { + + $('.navbar-fixed-top').headroom(); + + $('body').css('padding-top', $('.navbar').height() + 10); + $(window).resize(function(){ + $('body').css('padding-top', $('.navbar').height() + 10); + }); + + $('[data-toggle="tooltip"]').tooltip(); + + var cur_path = paths(location.pathname); + var links = $("#navbar ul li a"); + var max_length = -1; + var pos = -1; + for (var i = 0; i < links.length; i++) { + if (links[i].getAttribute("href") === "#") + continue; + // Ignore external links + if (links[i].host !== location.host) + continue; + + var nav_path = paths(links[i].pathname); + + var length = prefix_length(nav_path, cur_path); + if (length > max_length) { + max_length = length; + pos = i; + } + } + + // Add class to parent
  • , and enclosing
  • if in dropdown + if (pos >= 0) { + var menu_anchor = $(links[pos]); + menu_anchor.parent().addClass("active"); + menu_anchor.closest("li.dropdown").addClass("active"); + } + }); + + function paths(pathname) { + var pieces = pathname.split("/"); + pieces.shift(); // always starts with / + + var end = pieces[pieces.length - 1]; + if (end === "index.html" || end === "") + pieces.pop(); + return(pieces); + } + + // Returns -1 if not found + function prefix_length(needle, haystack) { + if (needle.length > haystack.length) + return(-1); + + // Special case for length-0 haystack, since for loop won't run + if (haystack.length === 0) { + return(needle.length === 0 ? 0 : -1); + } + + for (var i = 0; i < haystack.length; i++) { + if (needle[i] != haystack[i]) + return(i); + } + + return(haystack.length); + } + + /* Clipboard --------------------------*/ + + function changeTooltipMessage(element, msg) { + var tooltipOriginalTitle=element.getAttribute('data-original-title'); + element.setAttribute('data-original-title', msg); + $(element).tooltip('show'); + element.setAttribute('data-original-title', tooltipOriginalTitle); + } + + if(ClipboardJS.isSupported()) { + $(document).ready(function() { + var copyButton = ""; + + $(".examples, div.sourceCode").addClass("hasCopyButton"); + + // Insert copy buttons: + $(copyButton).prependTo(".hasCopyButton"); + + // Initialize tooltips: + $('.btn-copy-ex').tooltip({container: 'body'}); + + // Initialize clipboard: + var clipboardBtnCopies = new ClipboardJS('[data-clipboard-copy]', { + text: function(trigger) { + return trigger.parentNode.textContent; + } + }); + + clipboardBtnCopies.on('success', function(e) { + changeTooltipMessage(e.trigger, 'Copied!'); + e.clearSelection(); + }); + + clipboardBtnCopies.on('error', function() { + changeTooltipMessage(e.trigger,'Press Ctrl+C or Command+C to copy'); + }); + }); + } +})(window.jQuery || window.$) diff --git a/docs/pkgdown.yml b/docs/pkgdown.yml new file mode 100644 index 0000000..151b455 --- /dev/null +++ b/docs/pkgdown.yml @@ -0,0 +1,7 @@ +pandoc: 2.11.4 +pkgdown: 1.6.1 +pkgdown_sha: ~ +articles: + getting-started: getting-started.html +last_built: 2021-03-20T11:22Z + diff --git a/docs/reference/figures/README-pressure-1.png b/docs/reference/figures/README-pressure-1.png new file mode 100644 index 0000000000000000000000000000000000000000..7bc4c8f7db547c559fb01ef2a8848679c60e06a8 GIT binary patch literal 22985 zcmeIabyQXD*EYII2^A282L(Y|N(BRu*dPcD?>Ya~*I5_n>cwiWWkk!;w^#UVdlrffn1Af^ zk$aJM$(?Knt9UJf)h7J=zr^v%qy2WiIh>|>pNRJjOHA<>=}}r`<&SL$76m`*E4!9c zP1>cux!zjMmevtvOg!Y{WM9Ky_xY#jPQhiJ7y^3_g_z^xMCVY$Bdi>6UDoN(y_GR# z^{s!VYI5z%lJ7?GIJps~`%eyIQ@-vN-V~#!!t6i&e=L!xqzQghO^=HZ+124FBKyoJ z@I*W2xZT%F_B*Rv4yv(Hcq75Q6oh927%!?6EQ);fR4rgmCe|sm^L#PV|5c_hqz)s# zD*nuvd%B{Fr>&`nAsI5TPTYBI&-)kf#=?9lrQ zn|r7tC9}P+Gn1{CL{j(Z7h2xDpEpsaFF)?#Y?5K$f^TF^-*H*;qGYho1{Gb%=q1YY zNwmStwTcD-2CaOzPhR~JPG@VdT+-U%j6tsuf8D>_f6`I-^PaIm$cS9bGKCWFT14@U)E(iWyfHA#*D-6Yi~!aP4oVHor&(ZIuqB`kMAAx!1A2w zQz^PSbEQFrz`fK;YpfUJRF3WxIjdwEHTYFAaZFlp*h?j=rTc*eLIJEQBhLc!*> z>%lZko<9ah1;01h#@oa{81nk6HOy(FW25tc#x`EutiyT!iuuo+q;~}4rV)4g<3-fJ zaqzPkJQjHW;k|*B+~nyekMQqZbaA+zLHdkBs|@$cTPuSM_e?K}blX|W%)GAeLQ1#7 zahcsxf6Q}Z$y)w+L@y~sN%z>I%;nMCYN~^Wlt6Ee_h;M1`}{b1ZaQvP1j&TnTl-KB z`B&bVUF@)#%B?>+5?~seUl2Y0^h53F4?Th$E>`m6W7P>PGo_PdRIRBe3nEO$P;Xti zc-~t{?(I_aIj0!f#^dtrFyB~LFXSZ}&ctfjHmSenW&ERJ9+fGW>a?cd#Qafj2$QGN z=R=LE+?nPKnweD%Cridb)Hk;Z?fvat7x!hXjv-WW!amkMqZ8pL{jPd&5Ilx=C5>cc zP^|DX9tz`MQxrD*gaLogz+c3dU>;n-Oh~{w_!(mu`Oi~2ef=mD8YL+ztmK3-H*hS5 zw6k|((RhmX?aFhdu*A00#8b4NRD+hLQ#6QOZ+^=5O;lZ>)BW^>78CO+tuFz~2&;=J z-SFwq(koN9t(M~_cC40uGO023gf=o%ZMxCchALKampQLB@ER+yyONM&6QfZWzyHx= z2xPmp8F&H{kJbzI`=480s8B+TKmSjRrcK4fPPjbA#C>!ZrhN9{f1|u335dNuhrVn$ zdMF;c1o!ASJyta8jG`si&4YIm)1t=C9FBn4HywpxB3)8@{P3AD0Q18S|7QUIS%Lqo zz<*ZY|H}$2p#ufHFYAB)I+IhynVz2BBjuHJ;F!Ew@W@!?(MHX29AZz&{6waMB)LB2 zMto%m<4!kOT%YZsFR`5nKgD?aV5_El4fAWBBafOl~Wt$x@aliuvE}e50J=zP-kE|J$Vtn#I-~^2?*O z^wB!)sWM67$MES7Jnt)l7|*@USLaSG?`lzaSq_$~spp%Vzi{C~TZZbzbnS{#)6I_N z?X|g(XJ@b1txUBWeh#3_)vduyzms&U;Z7~_p#!Bg$LPjMpcj9BB`aomqB&w`bNN_i zk1q**vh73@*S+`H?WfLIGpo=YycloP*K6ihO^#-X!q)nHyx~InQ|IOJFmJ45b>+^> zHrQd(B!~Vwm)u$l)m!dtD=8&aUwUhQAlLf4Nc!D(i9bAM51&U%tbx%z@Nj;htjL78 z)V!N>sy*$+)DN{>1IgMjwumXLQqy*(s4J$y4Y4;=SFQ;V9>gEw7no^s@!=J&>vgYg z{+q0jay$5Fx1B=%viKV{b5J~BQd*V!JyO_V^UN#|GImM_k+UU`?A1Sjz zeK<#ARvfcjTqwb5*2pT_e6diRgZ1{ZHYXP;{K)e|78NIPDBxW2FO`d#NMjL@q|F9fFrGG$}=a^1Hb zT2(D@o{fF5FMsU&{cQIM5rwm{Zrb~Nug&E6a)eEyxC})#1g;Wys_p-KoKkN~@ncI+ z=ArQ>V3S|eW|tFK4IQc+tB;7d_3TV-u3`O7A!9E=cYzldiF=~f!;WLWX5c+~s->*3 z*ZxvVB36iF2JS>zr`8gANyW1%mMV3tAEf*N= zHS0%fLsDGVe^NTid|QV(M)?Zf%MoLJ^6S8&+wjQP@3z=&-msqzofN9bdwJYlNPzj9 zJq8PDtE((^&L0FcY~&ppO4e>6Uv`qIZ=@8ZBu7lz%G_so+x^cOpbf&-r1Wx;^=iU+ zQ}cSSU2I$aet&Um!?9@Q7a1Aj>2wEA@ah%{^AGtj=8Ui4~{?}9%i;VQ^#m*zVqKXc7V@l?_q0pV{Yv%H%s~8o@iKB@Z8^Z zEZJS_8ykOVb?wEF+e}uGs80(ew~<7eZ0u-3x3*LyshHTIX^E1+0e>S$)0Q6D#5+ON z+Nuu*!ab3wnxh@nB#E4-4^K`+buIn{5hrlK7F1r#3)=-dH;*{yyvVLAp3K_19mZ;? z`N{QQU?^`MVrwlLd1|+g5?kYTBBgCF&bx2XKg;F?o!5Gd8%49{`idf&h4%Yb2;Ju^ z))ikL`Fb_7%3;hqk<9ovoSdOkt!j)GqA7CF{`Ojzm zvp&C_(Epvbkxhi=s1F_}bF8m)-xkRc5I;JWA2qAPFeVEv`V1ypUMUoqDc43^j1Rq_ zccZGkJooq1aO3MDuUlzTf*WagdHtfXQtj!3 zXQOGQkcT(EydIICpU=)V+Vl1g&Y7S;bnqz52Xw=w8Vdkd$WMqk&h;|7Z>?N*=eI{G zWNVf*NNmWwyjGhm8Dj9Wza+6}O6|bMVqlL*Roi2jfMYcTY{=!bpi6m4*DHqC_Oo0* z0L7)T2%Xy*Dp@;)?=X)BWQ=%OR@KJntBrW;q|CBk!#OknBFM$@UpURG6bQ~N>Oz!F zcv$~mVC|H(A!<53074Z2lbv{gwAb1%I~OiKJ=_Q4c+BjxkCFqVMQP$GNK-@(67Po) z1_&WE9N`HdrBB)&SxqO`{O?kzV9MNGtd4lV{z^V*0OS`Gayrnzxs76u4Pd_&qg zGr67__b|D0`4Am+yuEjmQqaxGC@S4GtXG&b>^>GtD7`i6Ya49O(Z&J(Q@g2>B z=u<5YEB-n>-fz;qiH_!Qi74=kxlpSc0A$VtObco4LD+j9t?M`OHZENft6d-6S+ zqOaD!2EZ>1M$3FAa=dnVKf`t+*6}tZ0){&qi#D5M5fd?-yobODZv($L8^>;{EhRCe z+BF>O*vYS*sycHg1O;a7OPONx;|_5xnzj-fhN$hf_=(G+_X@AWY-G^=fzkpK^VbvM z<=Oe{QY%5x5CorJw7Bi_$6y{@2#ky4Bof+rTT=h#*~(AJ*Fn3-qL!N+<&pm2$LBcZBls^&INMvmR{w;pV&+ZJgc{w& z;ZnhbAZA*zKei&F;(g|-nQzluQj<+UL&@p|X5QD{aY|!gwp_yCrTXIm`q|{GJlxZj z(t{_>KaZ^sc}5_J@|@GKcR+?S&3O#fp@%O5F>3#uL3A*IiB9vy$_)_$a(0#!sfci4 zAKcnF0oMlU8+>y~g5RDnE@9?--5Lxf`*Rkm#V~OQ$O0j0jbdg2pxTlDgj1(d(`9XT zDp9>S<8{7Q>5SVQ^*>|wedtyA$YHLxbH`s~iD8N!P57D!@90=zC$a(Sr=_DHesCy> z7f5JPs~F$ukIt1H4jwvbMr!(C<4~A_0G$MBk4`eNZ#D|U#Liuk`p^wli+iCujy-yD zbW`hTTGX@bi|K!z06b!^Ew2TV!<%SJ;lZt|jP{486N3f=Q=W!c@GwWi6IJy>T`8?h zetzg0hw0I%X{`6+hc|go0@rz~JEG&zePFv`1Wlx2d~YjuPx`S_u=rpsy%V2uv(Bvp{%OK2w89l_$kR(B99whMd)~xltWHn(=4#= z<#%)ox&_lYW-Ug@v+{mlVIy_|MDV525V`1^E-RDg#r(;`FtBia4b_5!gGWNi`i_=? znD`5M%j!(G6dZ6dAGx6vNM3UFzntvJHw~F*5Dk}L4qjt7`zOo9U*dv<*=aInHv zs?u!}Go_L5aGx-+cd)6jdec^cn*!iQ1k4PTV@@v&u=bI ztTQE8*;$`DWI`Yq)Zp>pCa|ew21aokN9Qxi#Zg_7!EEtj&peED#CWvB|9Ck}cSxS3 z5u_THS2=$eLuiRhz4U2XT0%zg{#qAcZ|-Ag`?ufA~q{FJOQ0B==YE}p*r`_2Rek9qTHaIvsniaMyhQJ%W5z% zB2s>*7#oZ^+CM)#Yq+&C#ijrGxY}D?? zZ#c{@WIpXN2XM{E!O?hG=)`mVo~zaG(0_4sy4X}!H8a{d6>HG})HhT-c2`w5f4mS% zhUjH8T#Zp1d!xt=^76zNGXb4#WsX*@v`WX&t5fY?Ru(%jBuZ??xONo^ny3Fy`1UeN ztH?68-+g_+=Et+^PYWNK(KPToFMWl`brH}(5E75NvNZHn*ybEd|2I-E!V%ET7+{G| zl`Qp53w@l!BZO`ufI}g)w~=IO=myV~mNW(i7gCc5;PRqs(E6VPf?{tt-iG1nsf0vd zHIF9w$t)XliS)a9#zbuhbBf4g0)=!1Ms7yM27;Tn4r~R5c^)603*=E)TZ+_6(SorD zFan!Tr&S}H`FJEXZW5kmB~wTZ>Q$RSW!*`761A^bhBav?eF!>Gn2Q|4Jb04K4mzcF z>FnzH651|Pj2G^{O#oOVyyCpjEV!Mi=`xj~kZ;l&*%jc}mPC{_&dTPe9;l)UlNT$DwEb&S-%&3FgFZU8Vi0L@b{bkxt_ed4E8X z*A1Mm9G#1RJww4CNNz5TjUjmru*|g^i$54uvlE`=6z7ddDw+Krmq1_1CgAz8LD%^( z0oSz{i|YqY4jn@<`|aJ$CZT;dB)s(7cWb4F@`>pUmOCRX6PMe@0uKl8Cjv1Dew`mj zOwYAY=(yck>6!NqAM)64%zrre;0v{pEih}1k2by645|OD$;WsvLBj{tUKoSJic+s% z>;jCn8G*-ux+pbGS+F$J^)ZlHJ!dc4i@s<3*_?u*aXxz zX>3LwQUxB&tIU-rq z^p_u{r;#^I?Fg**(?c$P>2ycXB8|t!t4;q=;DW>9M19H}31N~6_Pa@U-?n+=qNtPvsofpXAc}EB@q<%JumnnoGhKCT(-a3FBuNjA%IIXI73-P7(YZE*%rV?ITRc_uIbe^DY6@0@V#1d}oRsK7p_KiaW z3p!eJjAo@?7oq`@&HSkc6wASi$Nt7MGQgSNe<(Be?<=Vn=L8xaFZ3A4`w3DAbopPa zf+|D5-H8_RR&Y;3U1GFCe@xZ)Z8dl>qhs1bX zgZ+cNesDO&5(sa5rlzKDolXbrlbF6&I!6D-?Kga(kS0M(Q*(L}$Frs+!B@EBivZyEa2;{uqs@ELuazKJ(u_eMxCJQTY~qg^0_8jL_dC zZv()DsD>EgHLc1QpG@ZU*o$n$XxD{apbue|Ynsvv6goJMUS2+4`Y82c>wBAk0j0T% zabK1qD5~6HrmIn!%v^Bc;El+65=PJp-&hU!+y)CLYVXvn_}-E9T@fgjP>Yh!9yt%M z>V3r5+Kx9|=7b%Dfdt>V0Vp_$NRK5iEB^pcZ*A zZa2H;wQPN|PmssXqIeX~gG9UeK`m{k?>JU%-8!BXp`2R1+fmn#mKdS!kE2zy)ENmW zI75L{j|!K!II+skcgYkCeLUV+t2}sFEg{=c`jp5B*)oS(+wbUxgg87FxDxm{>}V3Lry$J@XP-LCSh2}yQ768>zkM_b z6MV=|rNZrwp8Ve}&ypzHy@OYIe+ePwrD9d>r_tmg6R$fna zXc=AY)`R~f* zpw2#W9AZB{KQrvjH|5g%==+W0DHW**EZlin`mo;#2<;MP)$ZC$1XW>dyE^>rSM%80 zocL;d`>Eu4G%A`bE$a5~u@je~gXqLWHH5J^dRf7aThTA?{_B+lX*oT~AJQ@~1{1Jz zWemTwg0}12RUt1Z6ia-0PQBZehv}`0{m&z^fK%JQ&vxJ=OazMqpp%~N%3?!`!8hj1 z6_KnR;hJU#%2WqkX0jNRUeyH=Te}m!HdM=XUAJu2z&JpQ#A@EaJ4pc0+JObK84FXb zles>?03eCW+a!)ZUtdh+hO>h0SXiD#-!&-I1xUy8DX$<%u7R?>k_9rLFz_7pZ|{9b z1|p!=mMQ(hZzH{P>NQm2qp+^rt_`_=ilCSiHBj!H2NM=iP*6yQ3Z6oRi#_-GY>zIL zmj6aXa4JsaO~8Sfe#`-CwFOCJRGJ`>k=onY#HyPvH{cU^B=}BPL*#EZ8@N?>v}(5I z1&I93TpLR2b5{hchtW|$uJ1@Fo;oy840>Q@^I`RZ!^6j&w#Yd(S$d5h|5rlNk+9Nn zelSsZGFz)GSuS2M^@VY5Fe895%~YbvRGF6sZOM{cjz2Y9`&JIt6Qa)|Bl6_`MjycZ z=D*hm;EiS?)bZFGwY*fy?;Zd?df*(GWTXkEgR%a~5n9Rb9C?244KjpFf7Jl>jS`%A zNIU-@$aKEVot9TO8||deJPN;{_&MLjj8^?mA;ekardzNg>%o%Hmf%3OwoY`V*1bmI zpj2vIg)F^^oM_d(54a$j@cR+fDVPQj$EN=U^--YYB7_a@ggCU~ssaIN+LVrOCoxbVSeOE#hz%4yQ5tt2A8akH^)-b3jPsj3cH)d(p^KygbD~vGZpx%k znjxqFQs>j#J?Bq&)JR$8a=xNp_)ZgAkyIGyoI{QNR*yl9=h-q2_2l zitWTYNL9CLYnqMpF2V}~35wBE;aWsluvf>H^D%-wMfi|*#A87!G=LmaH6MIB&1E&n zulVZwhkxrs7Ae&mz6F_oN^N1hwX!&we2$&_p zU5J*Yy`vpwLIgHdYrW=%0Q^%wDQ>%6Gij-wiDi~M7X|90ew%s@E{`22({FEIIi9up zJzNQFj5(v!XYBqI7q4-@X9sq7<#Oi@$Ddd9=}x_R-f?~rsaQ;3a0bxPh_?ZigN@i% zpdG3Q@rv=o767rE7RG|)Zc;8X^8m-9|{BN#I;H`V+w}Wc-hy<=8Myx4ryd|QkN}=TERB@`wff_p7!^Tr zHjxR{83l&lAJ(I@9{ozvs>|JyxGO9mhjBbV)*kO;2!vYx*b{ZX4Wn8OJNlXhD~;#Q zgK7aJ3+dk_l=x7`13~iHhY*pV-%EhUVBIcrz1BG1oryy|f5B4Fc_~>bTeF8h0N^#} z;A*)rZ5*J5ADgrC*M7g73y+LLU1{y-fVq*+1?}=;d{OwIg}Pvo)ez^FH90wUKkaa@ zu!LoGO2F@6EvlZNTk{ZMKPBblC{FM}AZ@GcCK4!_#NlY*v&h-h-_#NZKIE2;$nclx8j5vv$@ z2d*UH&L1I+L{6BJy&l&QDfpG8I&b)J%-+N}FnkQ2zRU4GYQtd0>9lCYOnm1;|) z-`TE--gc0q!%#UtpkdU{v~Dl z`9L(x8sCm9{a1YkJ&Vm=AIz3rEV4A-$d+f^91h&F6y(ANLzV6dMV4Bi8MB@xxG9TQ zEbX<8#d+f%*)PyWD~JtD0+Xq!X|CtKM-^scypRqM(JZ|p(Kj3|tL8G%v^{`>WY*Zc zwtlUPft2q0&jE$P`)U{D6TF5NfjqoALqx?h{END#6+zW0|6VQhHS8-J{bi0hz*K*k zpM*+sJqXQ`@4nOX=(`InJ$8a7*6(dLkfQb6+ewW#h8%hnnDD_XE8u13#wxde{#Ywh zeS96yfINZ7#E9sRMf;M9!4wlj zW0wOlo7fX3zvw8-LV`RJeGO-&HKM5B#y^x@O+mfzJ|Y`f>QI#P6D*1aXfPt~b!TDG zmXihl*QX;f`A)e5F3bgJv`m%=0z65;c95S61{v0eOUCiL%{`WE_>Lzk3V_u2QZU}H zyJQI)qPWGwFX~vHdoksVZS?*9W0{#W!I$pS9qGJUqD$f^?|n!lY%ctQcnpuK0R)e2 zPQ+8hQVlvzb?3xKu?#v2#FLE}?Dj-5NgRs(W-pmU7C7o7{0EvEXY)Hr0}9uiJ+I8e_4$7GuhCE*Kw?|@asx1}BpqY~49wAH zNJhY#;QbvkcLP|tT)j^Oybnf1m2?ru1eP~A706{Yf-ehBKK8*?@N=|&u;YK6lY}J( z_2a=LaiS84Wri!0tw!1nNPq-iLw_kT9YFn4!K8}&J-NS+d+qsZ z+T>B5<_^e0gEi3_)T@Q-fI}J+Xf0lKAV-~h*$}Dj0mh(zvjQ+i0w4v0PNmxtFaT2C zm^h<8M1p}3F6xFn_Z#t6ea%At!Tbq_%)WawF(2wqx|p83s}acYwwY`>&n=WHSj&8- zzG%pUt;}JLtEit_kW_1;z9alj?2YC4{T*Y`ysoZJq5YlqhT6?u^PJknA72_77G2k7 zFLNZ2GzNSmMpr9?foAh*k%8r$lGJTY6dS*04`q27&swB#1ybRQeC~HX(_TJhuU+X@ z(hn3SMtf)9XwXSP0mH64^F;g$UYiqYzoZmsRNYnNK^@Dx8(>%UuzLuAvH?FJ!9;T@3z16zlVPD*;Hi;MakaDW4b&H)xqJ+>t9eF^xwGOUY9OV`ot;3x+?gdQzL)k=8FP)6 zFav^)3Y68@Z%S#rU5yi0$@g(8h#>oC{<(BJ;vMxPSUC; zDJsiz=Lb!=Kx)n-!UJrvL;ulBaYS3vQKPqA0ss*JHC_gK4uI*lJu7^`ybtnMXU1&8{K ztHw<+UVZP?Oow`}uOcdY!}VhY;hb7#Jv9~f0G|I1VgEwsg^s~Dk$wjUnukq!d}K1l zI$L96{Mn|h@ZEBqWkTgD{uO_b*10>e;RBebJ6*)+Pz4&3(mkL6pXJEFeW*^6 zb@K}O3H4bO^7^>#=9fE=pc^dZYj~B<(5-$xr+KeUR!VA_$y83zqN~S;=GRrr#;d00 zy5SGr#fw>BDr~Fhf9@o4-iH!&BtPhwCuN#F#tYPpUu>*q`*)mmMg1$e?Z+JVH8dG_ z132rvM3P6nS%FN|O_8tMZ*+(L0A`@Mn2&CLE^Rb2-<>qi>Y2t?UJ*pSA(?ybh4Z-o zl%f6HRy$S4UwlBril~-3Sj+&0aWYaAq9aF{{f*&5Yt^PWfxeydCUV{e9y)@n9g5)t zrPP+WRDcv8FaT_O9P+BhzmRHDXYNe0Y5hkK!kCy6uTN*>M2AN~>JmMygjH_B5rl^> zbDX#AX%<;yOT?AzjV7P+YN_0{sO%`PuXQXL3)jemJHI*Fe~T~pGz&YuE;Rv6$fc~r zAj_~0b7758ERJdFsc`laP6b!hG=kkIR=dc{B|J;a*wp<~K` z)(6e&l=~)&$%aBktuTu43H^`S1!H^}Q`RKyDF9c(H;on7oSJj5708qaT^|sOtp$%iy+9KT>jU7 zq56+Z(A%NbCU)%uQc}$A|JjqUd(GY@$T}Pl(;aP(O~Wb%yGvfOWLdi+Wp+~|MFM4P zc5f)Qr7jM$+@*HUXf}F2n&^%@r-4H1q*VqPsyUWSuev;!dk0Q5TusE{pQY`za&=J6)UM#G_weI;Eq1JB zWxA8Ctah8)xM=paKRE}3)nK_t-UwK<#b^0YQJ$I_b{*)E&WIuEqP^$jBJILKq z`|~~Rn#BVvm#t%MApBrivv8U(m8fW)5jjRJ2x5FZ0>=s9C4^fGXiDK|f;n*EvJPO!SB&*MLE%Ge&1Oc(LzY>jj{!l^H9 zS`ZpP7C6(Ni}lv4Xzi+yE8Vnp@cIoEtJS_`LUk9{AxGz_lnD0iDVFfT_s>T``lnZa zGID1NH8ZE5l{E04tai3x&VJ5FwsHt7 z^ED*6vxwGx;^?W9^@~=+fnx+t0MmPZP^s*;-#Y+Y#?)!X8)i zfR9USJ9650g^;tjx`B)M+0GRi>hsz5nHog^HIR(EryWP_jPEV;*8I6IqUvjN59;HH zI(D@ERJ4Cl>%VCB+qq}%_uBTVt#QaL)Q0`Bm13+VW>%#he{Cx&Yc^OHK@mUQw zBl)nC{B15`+}2(Eb0sJaYD4p(x~o2Hvl?D^b`^@OYF?&4%wN5&5wSw_DD&37*(Tk) z$*=c!F*>IFW(8Bbpw9V^pFy7VP4QH7)EjQ@Nm`!m@HhCydHl4PXJ+5MBx$fqop#bt3mmcd769YEXk5yGcV=p))n)v2L7SDI)}Wgw-ZUr-Yg%nhRzTB2LrUp z0f7!QBJa{lF7I5iA3royPz&s4;YDKt0P!~eJh#Loh;$`sBtZOLf6)}c1YWe2dkM|zr^;Ew)hM7 zhJMmPduDeqF*1Jg)DO;Sow?;XgzfUtEV%tEXe}F(?#%I~g~Yzk*^B!^B)*ky<3U+s z{aCQ4ASBd}qwVvEnsgL)f~<(z{UYY{aDb}*0^i-qT^|*y#}8G2c!bw! zLD%FMQ_bKSsV9SgfWS!ezAQH13G|%bq?nH#xhIBuYH2Ts0{gzn-6C}#&1qtKAFNg# zXRCtLJ-0UW!W%HR%I?xQYi8bk*Kl@&;Y}b433*1EsMdq@d2L{XFkyQ= z)?XX$2CS017?K$MF%x2CFo4%f!8`{Syu5OtK9YlnV9`HTl8AJ2D{G%R;*b_j>(aUC z1W|46K-t`1mQ@>aE-F^x9it36k=|1KjLDBZ>`^%Uaw2a)RyuydjSCY(V>qF8U_%~49z^ny;lklv7{;I;HKt!XTpD8E1QdqJ|Eu9NScl}Yv-L9s zk8c>{@`0{Wt=aq%dCjbCm-L8TQe9!pG75E?3HdI75SdG#WJOLZ%X^`J z>p|hoOV?`1cu6cCrYk0|;eY0dTfoYFohkWT0Recouu>?nFAI{{XaI5&+dl;ar5l zZacrR(DvD+BruAX_A4F!0JPTFd%}yMkZ(yr*V`CmoM9^~c2>1MC6;y*qWMrNiUX`8 zg=n5&Fkv7=an|CuQpvn~9_guY=*&=!fZ@7cbJhvzWQv^6*4-%&tX=y2{Ii;k{4l5v z^Ub<4O*!tqtyV90dZ!FZ=?v&53Ex$9IT;RfhIWkH&U8iQ89?I=EAyc4Nks#k%3T_( zH?G*4&gcTSmDOii*2oH^o^w1m<8#YwMC!5%PfXCcb+7qr%yc*BVzJGD79bBPjnBOMaxQNc-BIqsdaj{a{?fKnn{E9JXhs^YJ^;>K z14KVrt80B$8duFa-g1^s($z0-Ge*uZkyu=_8ob{lTw)Jhdg?;ED1+ zBxRsJu|{<4B-N#=$*aDl!w(7Bhfr5wfRXO~lcNSn_Abx~ngz-(<4ti*y586Rdz{Y0 z-p9CNyUq!?+%>EVUCbsNH)e@+FUKz(Z9J{2c@K(~9EzrZOUyhbOoo&F+wGIK84??j zwCdqvdzzg2=|;UFKkgIf9XMjB<_<5Xa77sUn5`1nZ zd?{*Gj1%u8GvJVs_Km{@5zJU!SRr45iCu&i=hbYfC)XiU??c1q*$7~0%^W;)RwU%mXZ)Lpd4tA%g zDc;l;FBKrMm>m|@_T069r|~ZT>ENf6rK9sz`{Z-$|NP!zQpeV_6=H7$DJcqC$B-U^ z&Z$yKrI+vYzdRjaWnZJY^jUZxR8xzPg`X?8_vjSA&A?y(9pw{fNgUc&Rv{9Y5zUq zcu3W`Ec5R5^A>^F7I;-ngIBQ-*)? zy$Yo#DgK>Lq#g|cIg~KUyel&ZG*cZrpLpE2>^6aBY0&wGa9{UWp;pSoS_i`byVfq5GP!roIs2vq z?o}E2LFfpCRO|B%eq9ycY?Rd9*i%^sLa(_=W7?1fA{7p{kr?4Ya*~Rt<*b{_^lQb2$(UEYiE)$HdY3k#MYj%g z4bW$QZjl&!l^a^MjeCnqp<-n8lylD5ifDmb5Ny`ZGO6k&bhqd&i&yO}>NO|p?p+A% z8d!#JLK2=@4|OnaoquCc_+Sh17W&cmbFdS5oj$Mrt8(MPwroIV(GWO?Xdgy@_pUSl z0P0{={Ms71N-VA&R%6573zO~F2x4hsf7Le=2{TP?XaY&F(&CLyG_gxmfzu6rjbdR1tDQ;s_Eevi*B z_A=#fZM<8vx;430_-b*RQ?m*0b3MPS#k;RX85Z5WyVlOvAiA>VyZAbsgPF8j@|FF2 z;~^wGM!LJT+qX}kudPuecP2}c)}QM%?~!x7ETrflB*fiX=q}Z(Q6ZYwQ|Vq7wXHN` z`Qqo=wlPs1mp#$%U=+ydoJ3UIvS~NuGQ%PC5@h5bb}CQ6DG)tdR?xrmvooGKw!JNG zudzYsz7R?6jW1~eIAPAOYY_Ib$7h2*HopqYC0wBF(K>;I%1hnKvWJVyB22AknG&17 zhh)jUdV35%QU|rQ;s<2#-8G2?Do*9uyl&d%SO1>llG|%VcT}!g+E2B8!cK~7n~Zop zkgM-O(i=O}nB1}@`dm~S6Gu&bNH_bX?%IPqEtP8yswbCile>fV+9jv1;&l#pKyLxrvG8=&Kk^#91x?V)vkELvY98F^fI0~Z=QJ& zS>&G; zSn5+8GAO|RweI}S{Z`I2*oXLDv}-ns(WrP z_VU2#fcP9^I!`8)%xIp}zyT`v<{{H1R-lR_dwTHoD|igKfVk=6wWbfX>>ppjmH&L^ zPX_n@=k>`oZazmT*0omOtZODAT%UwP#3L+}_Dj0hBrX2hix@zIS%GT)W6Ogr8 z@<@e38(=P@b+?vdEm9D<R8!1nA9sZE6)R1xV2q(J?|tZ5&dZM9QL8=RmR;@#UPW zGzk3#N&p5ST_ZN|k!aLB^wNew(pn4Hfdz2R(z&Ffs;e(RJQ5xL6~3;f7L@BhKeg*mKwNPqF1{Pp^ z7vi4*NdCv&p;}`Ag{kq138AcvLIT%tXv_QxNrdQn7Swy)KznJSt4rIoy`G}Gm%QjqaXVv@Q~pk z%8W9b+6KXx1l0IshBuKWUI-s_NV<@mmR8SE)K7=V9ATg2K#oZdjeZe6$B60xOeDi~ zCX){Pi{%RsH33%V+Kk;Moy84VN0fRX8BFaggc7|1eDTjF4sgyN;63{58?&g zlOaR1sllQ6YEd-6bbY`s1PVq7EH#>bhd^^^#o&%*Jz)Tywo_VZ7`f*%yt7gjp(_nP zHD(ao388ll#H%X}KOp)ahDryTz^?04m`FOQzHUE*)i-FkYAW-dvx{c|YMx zWUj=|(YBY#0Zq}sSN0;sQ44Y-jZc@dn}94E=A_&9N1D<0f$7}*Nj>eX-C`5 z>UO_u>Myb7xPi`}9foH@!O*A*3UN{PNNZ92Ty;m89P}V&!dFc>3C)}>Q|>Z@Hfl#L z5E8QAxLYV2FF2<~AhlN_ELd4nEAjwK)rkWr7bd&rSy?5T~E8RdcPxOrON z6AoOK7p^%Jdcu)*L(j_7ts3)jVm|c&QlQjsv@jd8rxcpmM!wTUT^ZCbq)tzQiw1I| zFPzw2fF8oSZ}0RQ=N@oKfrdpoUa9PRjn$C6szJlWP@5;wMB7M#{v2>7FR-EWEpP!7 z%DiM2VdYQ+9g8xKTg=EQw00psv6P#)1ECf=S3KrlfdVE3lu;5q&T`O1vT~!-2AVc{ zkN?vav^x=F`y5}SA_~Vze<->+U#0%X*?ee>_te3870Rvn{#SpZ2(d1i8{XYnI2u1m zThKCTdTnAuGk6Xb7zNvcF8fmnF=+a(JjFhQv38Bbb>X{Qeo}&f*^0voc6ST}N8COE z`LleNZnqb0TSo6(ao6Iv?_38infwHgfWKvX-@38J`wJ62ZH8yT;U3ANXuo4$!E0}w z0gWBGt9)RTjimTP$oA)!;M=GoHG0<)=$9)&a&fPFAL=tfAnuI}nnC)NphdhsfUEnF zJwfv9sC$oLgrC6V*Ol!KS_SdWbzm1lJKK*bXb~R?@IGrB=@kZIAPf@6T97UwO^`+|^fK4WoOK|{GIB`++BRB6gE}-> zII+p_jr|h4i@)|vO8fPx#O2Uw%``so*G-Gg&_LLV>S=51QPS~j*K^KUc4MXO+5 zSmTIUaD8hW#y5kQ9}jVhj_sL8W|zj*>;^z7lLBqNsh+9E?hZOt8zY3=BU&0f_M9^A zxE1qgCb{08Mh%S{tKp^dXlA+6tv6Zay|>@&-V~^ZF)>`d+Swnxo=G?k?>o+9u_g?n z6Y`C!xQW_1^c?6oym9hBUDRJlSMIc*h;y}6GRrD@pGP40p|-ExYW4o(E@9Ei`kuOx zGON$ctyk(Ii4g6_CN}U4ZWA$QerdlDMxB?nnqz}%jM)~OSc1$Od|MR8ExtOzA9k{S z3PRIJ_qC`3#HHZqZ(Utc@JCWiRy12g_u>Bnvs1v0 literal 0 HcmV?d00001 diff --git a/docs/reference/index.html b/docs/reference/index.html new file mode 100644 index 0000000..6ca6f69 --- /dev/null +++ b/docs/reference/index.html @@ -0,0 +1,161 @@ + + + + + + + + + • gamsnip + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    + + + + +
    + +
    +
    +
    +

    Reference

    +
    + + + + + + + + + + +
    +
    + + +
    + + +
    +
    +

    Developed by First Last.

    +
    + +
    +

    Site built with pkgdown 1.6.1.

    +
    + +
    +
    + + + + + + + + diff --git a/docs/reference/pipe.html b/docs/reference/pipe.html new file mode 100644 index 0000000..4111009 --- /dev/null +++ b/docs/reference/pipe.html @@ -0,0 +1,176 @@ + + + + + + + + +Pipe operator — %>% • gamsnip + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    + + + + +
    + +
    +
    +
    +

    Pipe operator

    + + +
    + +
    +

    See magrittr::%>% for details.

    +
    + + 
    lhs %>% rhs
    + +

    Arguments

    + + + + + + + + + + +
    lhs

    A value or the magrittr placeholder.

    rhs

    A function call using the magrittr semantics.

    + +

    Value

    + +

    The result of calling rhs(lhs).

    + +
    + +
    + + +
    +
    +

    Developed by First Last.

    +
    + +
    +

    Site built with pkgdown 1.6.1.

    +
    + +
    +
    + + + + + + + + diff --git a/docs/reference/tidyeval.html b/docs/reference/tidyeval.html new file mode 100644 index 0000000..e835245 --- /dev/null +++ b/docs/reference/tidyeval.html @@ -0,0 +1,224 @@ + + + + + + + + +Tidy eval helpers — tidyeval • gamsnip + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    + + + + +
    + +
    +
    +
    +

    Tidy eval helpers

    + + +
    + +
    + +
      +

    • sym() creates a symbol from a string and +syms() creates a list of symbols from a +character vector.

      • +

    • enquo() and +enquos() delay the execution of one or +several function arguments. enquo() returns a single quoted +expression, which is like a blueprint for the delayed computation. +enquos() returns a list of such quoted expressions.

      • +

    • expr() quotes a new expression locally. It +is mostly useful to build new expressions around arguments +captured with enquo() or enquos(): +expr(mean(!!enquo(arg), na.rm = TRUE)).

      • +

    • as_name() transforms a quoted variable name +into a string. Supplying something else than a quoted variable +name is an error.

      +

      That's unlike as_label() which also returns +a single string but supports any kind of R object as input, +including quoted function calls and vectors. Its purpose is to +summarise that object into a single label. That label is often +suitable as a default name.

      +

      If you don't know what a quoted expression contains (for instance +expressions captured with enquo() could be a variable +name, a call to a function, or an unquoted constant), then use +as_label(). If you know you have quoted a simple variable +name, or would like to enforce this, use as_name().

      • +
    + +

    To learn more about tidy eval and how to use these tools, visit +https://tidyeval.tidyverse.org and the +Metaprogramming +section of Advanced R.

    +
    + + + + +
    + +
    + + + +
    + + + + + + + +