From 599c5c4052568e477dbafe7a3f4510ec63317c1c Mon Sep 17 00:00:00 2001 From: "Steven Paul Sanderson II, MPH" Date: Fri, 14 Jan 2022 15:22:59 -0500 Subject: [PATCH] update gitignore --- .gitignore | 2 +- docs/404.html | 105 +++++ docs/LICENSE-text.html | 82 ++++ docs/LICENSE.html | 86 +++++ docs/articles/getting-started.html | 112 ++++++ docs/articles/index.html | 79 ++++ docs/authors.html | 100 +++++ docs/bootstrap-toc.css | 60 +++ docs/bootstrap-toc.js | 159 ++++++++ docs/docsearch.css | 148 +++++++ docs/docsearch.js | 85 ++++ docs/index.html | 158 ++++++++ docs/link.svg | 12 + docs/news/index.html | 82 ++++ docs/pkgdown.css | 384 +++++++++++++++++++ docs/pkgdown.js | 108 ++++++ docs/pkgdown.yml | 7 + docs/reference/figures/README-pressure-1.png | Bin 0 -> 3744 bytes docs/reference/index.html | 76 ++++ docs/reference/pipe.html | 97 +++++ docs/reference/tidyeval.html | 219 +++++++++++ docs/sitemap.xml | 36 ++ 22 files changed, 2196 insertions(+), 1 deletion(-) 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/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 create mode 100644 docs/sitemap.xml diff --git a/.gitignore b/.gitignore index 16add95a..21fd6a3f 100644 --- a/.gitignore +++ b/.gitignore @@ -3,5 +3,5 @@ .Rdata .httr-oauth .DS_Store -docs +#docs inst/doc diff --git a/docs/404.html b/docs/404.html new file mode 100644 index 00000000..130e0823 --- /dev/null +++ b/docs/404.html @@ -0,0 +1,105 @@ + + + + + + + +Page not found (404) • TidyDensity + + + + + + + + + + + +
+
+ + + + +
+
+
+

Page not found (404)

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

+

Developed by First Last.

+
+ +
+

+

Site built with pkgdown 2.0.1.

+
+ +
+
+ + + + + + + + diff --git a/docs/LICENSE-text.html b/docs/LICENSE-text.html new file mode 100644 index 00000000..5822c3c8 --- /dev/null +++ b/docs/LICENSE-text.html @@ -0,0 +1,82 @@ + +License • TidyDensity + + +
+
+ + + +
+
+
+

License

+
+ +
YEAR: 2022
+COPYRIGHT HOLDER: Steven Paul Sandeson II, MPH
+
+ +
+ + + +
+ + + +
+

Developed by First Last.

+
+ +
+

Site built with pkgdown 2.0.1.

+
+ +
+ + + + + + + + diff --git a/docs/LICENSE.html b/docs/LICENSE.html new file mode 100644 index 00000000..6737c4ff --- /dev/null +++ b/docs/LICENSE.html @@ -0,0 +1,86 @@ + +MIT License • TidyDensity + + +
+
+ + + +
+
+
+

MIT License

+
+ +
+ +

Copyright (c) 2022 Steven Paul Sandeson II, MPH

+

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 2.0.1.

+
+ +
+ + + + + + + + diff --git a/docs/articles/getting-started.html b/docs/articles/getting-started.html new file mode 100644 index 00000000..8f96e312 --- /dev/null +++ b/docs/articles/getting-started.html @@ -0,0 +1,112 @@ + + + + + + + +Getting Started with TidyDensity • TidyDensity + + + + + + + + + + + + +
+
+ + + + +
+
+
+

Getting Started with TidyDensity

+ + + + + +
+ + + +
+library(TidyDensity)
+
+ + + +
+ + + +
+

+

Developed by First Last.

+
+ +
+

+

Site built with pkgdown 2.0.1.

+
+ +
+
+ + + + + + + + diff --git a/docs/articles/index.html b/docs/articles/index.html new file mode 100644 index 00000000..6dba9a9e --- /dev/null +++ b/docs/articles/index.html @@ -0,0 +1,79 @@ + +Articles • TidyDensity + + +
+
+ + + +
+
+
+

Articles

+
+ +
+

All vignettes

+

+ +
Getting Started with TidyDensity
+
+
+
+
+ + +
+

Developed by First Last.

+
+ +
+

Site built with pkgdown 2.0.1.

+
+ +
+ + + + + + + + diff --git a/docs/authors.html b/docs/authors.html new file mode 100644 index 00000000..590851c9 --- /dev/null +++ b/docs/authors.html @@ -0,0 +1,100 @@ + +Authors and Citation • TidyDensity + + +
+
+ + + +
+
+
+
+

Authors

+
+ + +
  • +

    First Last. Author, maintainer. +

    +
    • +
+
+
+

Citation

+ +
+
+ + +

Last F (2022). +TidyDensity: What the Package Does (One Line, Title Case). +R package version 0.0.0.9000. +

+ 
@Manual{,
+  title = {TidyDensity: What the Package Does (One Line, Title Case)},
+  author = {First Last},
+  year = {2022},
+  note = {R package version 0.0.0.9000},
+}
+ +
+ +
+ + + +
+

Developed by First Last.

+
+ +
+

Site built with pkgdown 2.0.1.

+
+ +
+ + + + + + + + diff --git a/docs/bootstrap-toc.css b/docs/bootstrap-toc.css new file mode 100644 index 00000000..5a859415 --- /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 00000000..1cdd573b --- /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 00000000..e5f1fe1d --- /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 00000000..b35504cd --- /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 00000000..78e393a8 --- /dev/null +++ b/docs/index.html @@ -0,0 +1,158 @@ + + + + + + + +What the Package Does (One Line, Title Case) • TidyDensity + + + + + + + + + + + + +
    +
    + + + + +
    +
    +
    +

    TidyDensity +

    + + +

    The goal of TidyDensity is to …

    +
    +

    Installation +

    +

    You can install the development version of TidyDensity from GitHub with:

    +
    +# install.packages("devtools")
+devtools::install_github("spsanderson/TidyDensity")
    +
    +
    +

    Example +

    +

    This is a basic example which shows you how to solve a common problem:

    +
    +library(TidyDensity)
+## basic example code
    +

    What is special about using README.Rmd instead of just README.md? You can include R chunks like so:

    +
    +summary(cars)
+#>      speed           dist       
+#>  Min.   : 4.0   Min.   :  2.00  
+#>  1st Qu.:12.0   1st Qu.: 26.00  
+#>  Median :15.0   Median : 36.00  
+#>  Mean   :15.4   Mean   : 42.98  
+#>  3rd Qu.:19.0   3rd Qu.: 56.00  
+#>  Max.   :25.0   Max.   :120.00
    +

    You’ll still need to render README.Rmd regularly, to keep README.md up-to-date. devtools::build_readme() is handy for this. You could also use GitHub Actions to re-render README.Rmd every time you push. An example workflow can be found here: https://github.com/r-lib/actions/tree/v1/examples.

    +

    You can also embed plots, for example:

    +

    +

    In that case, don’t forget to commit and push the resulting figure files, so they display on GitHub and CRAN.

    +
    +
    +
    + + +
    + + +
    +

    +

    Developed by First Last.

    +
    + +
    +

    +

    Site built with pkgdown 2.0.1.

    +
    + +
    +
    + + + + + + + + diff --git a/docs/link.svg b/docs/link.svg new file mode 100644 index 00000000..88ad8276 --- /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 00000000..fc34ceb6 --- /dev/null +++ b/docs/news/index.html @@ -0,0 +1,82 @@ + +Changelog • TidyDensity + + +
    +
    + + + +
    +
    +
    +

    Changelog

    + +
    + +
    +

    TidyDensity 0.0.0.9000

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

    Developed by First Last.

    +
    + +
    +

    Site built with pkgdown 2.0.1.

    +
    + +
    + + + + + + + + diff --git a/docs/pkgdown.css b/docs/pkgdown.css new file mode 100644 index 00000000..80ea5b83 --- /dev/null +++ b/docs/pkgdown.css @@ -0,0 +1,384 @@ +/* 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; +} + +/* Ensure in-page images don't run outside their container */ +.contents img { + max-width: 100%; + height: auto; +} + +/* 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 { + display: none; + margin-left: 5px; + width: 20px; + height: 20px; + + background-image: url(./link.svg); + background-repeat: no-repeat; + background-size: 20px 20px; + background-position: center center; +} + +h1:hover .anchor, +h2:hover .anchor, +h3:hover .anchor, +h4:hover .anchor, +h5:hover .anchor, +h6:hover .anchor { + display: inline-block; +} + +/* 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, code, pre code { + background-color: #f8f8f8; + color: #333; +} +pre, pre code { + white-space: pre-wrap; + word-break: break-all; + overflow-wrap: break-word; +} + +pre { + border: 1px solid #eee; +} + +pre .img, pre .r-plt { + margin: 5px 0; +} + +pre .img img, pre .r-plt img { + background-color: #fff; +} + +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 */ + +.error {font-weight: bolder;} +.warning {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: ""; + } +} + +/* Section anchors --------------------------------- + Added in pandoc 2.11: https://github.com/jgm/pandoc-templates/commit/9904bf71 +*/ + +div.csl-bib-body { } +div.csl-entry { + clear: both; +} +.hanging-indent div.csl-entry { + margin-left:2em; + text-indent:-2em; +} +div.csl-left-margin { + min-width:2em; + float:left; +} +div.csl-right-inline { + margin-left:2em; + padding-left:1em; +} +div.csl-indent { + margin-left: 2em; +} diff --git a/docs/pkgdown.js b/docs/pkgdown.js new file mode 100644 index 00000000..6f0eee40 --- /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 = ""; + + $("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.replace(/\n#>[^\n]*/g, ""); + } + }); + + 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 00000000..399eabea --- /dev/null +++ b/docs/pkgdown.yml @@ -0,0 +1,7 @@ +pandoc: 2.11.4 +pkgdown: 2.0.1 +pkgdown_sha: ~ +articles: + getting-started: getting-started.html +last_built: 2022-01-14T20:20Z + diff --git a/docs/reference/figures/README-pressure-1.png b/docs/reference/figures/README-pressure-1.png new file mode 100644 index 0000000000000000000000000000000000000000..c092055f2d496ba61e9f3073c00bd2087bd1a77b GIT binary patch literal 3744 zcmds4cTiL57LOQdLJ$E#L6EY5NQqd0NC_$eYfz-C6cLHUm7<80gc714O@g|FA|@(} zC`fS;5DmQ-6G0FOgqnb1Nq|6rfaG1=owqx)Z|3dW_s5%gcg~&jednBe?sw1c{Jw8) zg8eCLN%39cAP`8>*5O_AS4X9@HFH%9}uyJo{3CzC)tm=#HaZ9JLhciPdH(6D0PI!MOnR~l;_c^~o z&cnD(?fPmYO=IBuZF7@y#|F70E{r$Y^0p;+jJh6J%uo;q>a^*{Bh9QRS}gB+Y2YCu zju-Xpk^DZaEcLg!)TKoo?;~TBgk7vf$sV~~>eMw9k&JO#0(o3` zYeQRucf9TU(a5<|_|vFFl}E0B6p1l}>VU@w*eQm+waFGpFF-4W9jG&E{`5)G(8cR% z6-i~`o=vH`P#M6l$R**Kp^&PPn`wt@3YND3&J}l!OeTRDAdljj#P)3sGiF*!tH|5p zPmu7<=S_3NRV-5o--8ov*M`TWa2-m*L;BrJ6>TE2UTAGIgG+LY2?fg4e|`aXgBraa5X-|TYxlAzyqtMZPcGOLQ~-#(Ui=T>ZV|@ zm9{cg+0)$oQ^ALDDtj0g1QA!Pq2QQSF;BUq8c$nkZOyr@3-*m|rrJA3xI1cK0Ubw@ zW(!U=PKKmSJmNhY@*^TXswW#0MSPzqW1&EooMBqVYq2~o(*x9;fiXa{2gY0y5QMk+ zrX-k_s(Rg~ew8z0^jl=1yL`@=#V1_FH8rX=gBHF;Pfj2kU2V0bpT@K^0vCia7{s}5jNv$ zVjEk*yGhIFRWpZtz!_CztFzvD^}r%fL=4k%8kOf2Ew6$EFmG{QBl4+jh6mkZ1kyLA z(j~APus+1O5YJ@IqVo38tOg`x7W3Xj2sLSR;*RdZ{x@>5x@2Eha-h!g=0HQGblI?% zMP3zhybT6yy-v1}A8>0Gp*u*p{7^}5;W1c>&Ac_ z!3HdTKVN1so**T3+jcO4-;fCR-u^|YtZlw>H{VnSd-0y1>)c}Y8p@g!`uzlVdnazp z`XoIXC4n8&N}|^VY-sSVo5tW1B=7iReh+a+6c0JxPROZ}X&r=m_RvsgTQ zv-zxMgIR1^#Wf+x<=SkCP=gcicUY@qrlv_}(uB-r+!-s8%|TCHU-*35RDC+xa4Jxm zPfoFz525D&^T^Y&VTf@yQ$Hf-PreAe>nrlLgctYVduacx#g2vxG zm61QxbQTX!cwD})Sxh90O z5y?8TRA!W7Km6c^ui`Y9$Zd*z`=`G6$>A`Q{3UMxI_6d25$|1^tp&X@N2u@m zTL#OC#9}npt;IjY@oNB>@;J*Ifd*RobZa|-T4qG>zG^`%Tvqhp-15)ZR_x+60iUJ~ zsJNu>AK0QO;lo($J~brz=-8o#e%@5D2i=++X6cXak@TTukKc4O5B6RAe52u3*z2O> zkcD}l1;WchA4Y)V*TE|3wYV$sVkOp$(xytI8R#Znp6=Cu+ z%2OeMyY@9&b+5qeIc8V-CSJ4c`n>GAc-*}>@t`&ri{5uet_#mHSv4qncKTded8v9%E|j(Cov1TcxH*L$7>L)l{9=}| zo8HJPx~#zU<*G}b3*EP}6&gwoH2T4-kR@<1=k^Pqi+mQTR1Lf{1nKM4n^SDmWtUn& zBNGIN&?{5b9+B79elF(x7`c0jiP_04k5;z@vkDM})lDI9!IrDm!9?CoE5evy<~@u% zZ?+DjR&aeYXkYy=N#_^qQ2FMA?31M8nR~}(DyHE{GF_8`$Rn}UIR*`be2&H)c%;W& z(&Wi(FCqUL58r+>bT&)tNIndj6xx=$%)AY6MmZ5Ly$-4)_sbj6n-%+EB4NjIm z7-qk>B=UUY7zdJ^hP-IJ`RC!lms4jem89;#8`P;Wq6bZdB)=VxfB$c5CUD(esJc1` Szq;|KX=`=rc+t@dvHt+rJImPs literal 0 HcmV?d00001 diff --git a/docs/reference/index.html b/docs/reference/index.html new file mode 100644 index 00000000..f472d15e --- /dev/null +++ b/docs/reference/index.html @@ -0,0 +1,76 @@ + + • TidyDensity + + +
    +
    + + + +
    +
    +
    +

    Reference

    +
    + +
    + + +
    + + +
    +

    Developed by First Last.

    +
    + +
    +

    Site built with pkgdown 2.0.1.

    +
    + +
    + + + + + + + + diff --git a/docs/reference/pipe.html b/docs/reference/pipe.html new file mode 100644 index 00000000..c85095b2 --- /dev/null +++ b/docs/reference/pipe.html @@ -0,0 +1,97 @@ + +Pipe operator — %>% • TidyDensity + + +
    +
    + + + +
    +
    +
    +

    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 2.0.1.

    +
    + +
    + + + + + + + + diff --git a/docs/reference/tidyeval.html b/docs/reference/tidyeval.html new file mode 100644 index 00000000..3b28510b --- /dev/null +++ b/docs/reference/tidyeval.html @@ -0,0 +1,219 @@ + +Tidy eval helpers — tidyeval • TidyDensity + + +
    +
    + + + +
    +
    +
    +

    Tidy eval helpers

    + + +
    + +
    +

    This page lists the tidy eval tools reexported in this package from +rlang. To learn about using tidy eval in scripts and packages at a +high level, see the dplyr programming vignette +and the ggplot2 in packages vignette. +The Metaprogramming section of Advanced R may also be useful for a deeper dive.

    • The tidy eval operators {{, !!, and !!! are syntactic +constructs which are specially interpreted by tidy eval functions. +You will mostly need {{, as !! and !!! are more advanced +operators which you should not have to use in simple cases.

      +

      The curly-curly operator {{ allows you to tunnel data-variables +passed from function arguments inside other tidy eval functions. +{{ is designed for individual arguments. To pass multiple +arguments contained in dots, use ... in the normal way.

      my_function <- function(data, var, ...) {
+  data %>%
+    group_by(...) %>%
+    summarise(mean = mean({{ var }}))
+}
      • +

    • enquo() and enquos() delay the execution of one or several +function arguments. The former returns a single expression, the +latter returns a list of expressions. Once defused, expressions +will no longer evaluate on their own. They must be injected back +into an evaluation context with !! (for a single expression) and +!!! (for a list of expressions).

      my_function <- function(data, var, ...) {
+  # Defuse
+  var <- enquo(var)
+  dots <- enquos(...)
+
+  # Inject
+  data %>%
+    group_by(!!!dots) %>%
+    summarise(mean = mean(!!var))
+}
      + +

      In this simple case, the code is equivalent to the usage of {{ +and ... above. Defusing with enquo() or enquos() is only +needed in more complex cases, for instance if you need to inspect +or modify the expressions in some way.

      • +

    • The .data pronoun is an object that represents the current +slice of data. If you have a variable name in a string, use the +.data pronoun to subset that variable with [[.

      my_var <- "disp"
+mtcars %>% summarise(mean = mean(.data[[my_var]]))
      • +

    • Another tidy eval operator is :=. It makes it possible to use +glue and curly-curly syntax on the LHS of =. For technical +reasons, the R language doesn't support complex expressions on +the left of =, so we use := as a workaround.

      my_function <- function(data, var, suffix = "foo") {
+  # Use `{{` to tunnel function arguments and the usual glue
+  # operator `{` to interpolate plain strings.
+  data %>%
+    summarise("{{ var }}_mean_{suffix}" := mean({{ var }}))
+}
      • +

    • Many tidy eval functions like dplyr::mutate() or +dplyr::summarise() give an automatic name to unnamed inputs. If +you need to create the same sort of automatic names by yourself, +use as_label(). For instance, the glue-tunnelling syntax above +can be reproduced manually with:

      my_function <- function(data, var, suffix = "foo") {
+  var <- enquo(var)
+  prefix <- as_label(var)
+  data %>%
+    summarise("{prefix}_mean_{suffix}" := mean(!!var))
+}
      + +

      Expressions defused with enquo() (or tunnelled with {{) need +not be simple column names, they can be arbitrarily complex. +as_label() handles those cases gracefully. If your code assumes +a simple column name, use as_name() instead. This is safer +because it throws an error if the input is not a name as expected.

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

    Developed by First Last.

    +
    + +
    +

    Site built with pkgdown 2.0.1.

    +
    + +
    + + + + + + + + diff --git a/docs/sitemap.xml b/docs/sitemap.xml new file mode 100644 index 00000000..20850ad5 --- /dev/null +++ b/docs/sitemap.xml @@ -0,0 +1,36 @@ + + + + /404.html + + + /articles/getting-started.html + + + /articles/index.html + + + /authors.html + + + /index.html + + + /LICENSE-text.html + + + /LICENSE.html + + + /news/index.html + + + /reference/index.html + + + /reference/pipe.html + + + /reference/tidyeval.html + +