From 6ea84804eb6886f965225fba1cc7defd170ecf17 Mon Sep 17 00:00:00 2001 From: Murat Tasan Date: Thu, 12 Sep 2024 12:17:50 +0200 Subject: [PATCH] v0.6.0 --- 404.html | 93 +++++ LICENSE-text.html | 70 ++++ LICENSE.html | 74 ++++ authors.html | 88 +++++ bootstrap-toc.css | 60 ++++ bootstrap-toc.js | 159 +++++++++ docsearch.css | 148 ++++++++ docsearch.js | 85 +++++ index.html | 110 ++++++ link.svg | 12 + pkgdown.css | 384 +++++++++++++++++++++ pkgdown.js | 108 ++++++ pkgdown.yml | 5 + reference/add_class.html | 100 ++++++ reference/chunk.html | 122 +++++++ reference/dict.html | 99 ++++++ reference/grapes-equals-equals-grapes.html | 74 ++++ reference/index.html | 124 +++++++ reference/itself.html | 78 +++++ reference/logit.html | 74 ++++ reference/matchval.html | 102 ++++++ reference/murlib.core-package.html | 75 ++++ reference/nop.html | 86 +++++ reference/notin.html | 80 +++++ reference/null2.html | 92 +++++ reference/replace_specials.html | 107 ++++++ reference/safe_sample.html | 82 +++++ reference/trailing_args.html | 74 ++++ reference/typed_na.html | 93 +++++ 29 files changed, 2858 insertions(+) create mode 100644 404.html create mode 100644 LICENSE-text.html create mode 100644 LICENSE.html create mode 100644 authors.html create mode 100644 bootstrap-toc.css create mode 100644 bootstrap-toc.js create mode 100644 docsearch.css create mode 100644 docsearch.js create mode 100644 index.html create mode 100644 link.svg create mode 100644 pkgdown.css create mode 100644 pkgdown.js create mode 100644 pkgdown.yml create mode 100644 reference/add_class.html create mode 100644 reference/chunk.html create mode 100644 reference/dict.html create mode 100644 reference/grapes-equals-equals-grapes.html create mode 100644 reference/index.html create mode 100644 reference/itself.html create mode 100644 reference/logit.html create mode 100644 reference/matchval.html create mode 100644 reference/murlib.core-package.html create mode 100644 reference/nop.html create mode 100644 reference/notin.html create mode 100644 reference/null2.html create mode 100644 reference/replace_specials.html create mode 100644 reference/safe_sample.html create mode 100644 reference/trailing_args.html create mode 100644 reference/typed_na.html diff --git a/404.html b/404.html new file mode 100644 index 0000000..fd8f466 --- /dev/null +++ b/404.html @@ -0,0 +1,93 @@ + + + + + + + +Page not found (404) • murlib.core + + + + + + + + + + + +
+
+ + + + +
+
+
+

Page not found (404)

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

+

Developed by Murat Tasan.

+
+ +
+

+

Site built with pkgdown 2.1.0.

+
+ +
+
+ + + + + + + + diff --git a/LICENSE-text.html b/LICENSE-text.html new file mode 100644 index 0000000..8e04111 --- /dev/null +++ b/LICENSE-text.html @@ -0,0 +1,70 @@ + +License • murlib.core + + +
+
+ + + +
+
+
+

License

+
+ +
YEAR: 2023
+COPYRIGHT HOLDER: murlib.core authors
+
+ +
+ + + +
+ + + +
+

Developed by Murat Tasan.

+
+ +
+

Site built with pkgdown 2.1.0.

+
+ +
+ + + + + + + + diff --git a/LICENSE.html b/LICENSE.html new file mode 100644 index 0000000..e8c29be --- /dev/null +++ b/LICENSE.html @@ -0,0 +1,74 @@ + +MIT License • murlib.core + + +
+
+ + + +
+
+
+

MIT License

+
+ +
+ +

Copyright (c) 2023 murlib.core authors

+

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 Murat Tasan.

+
+ +
+

Site built with pkgdown 2.1.0.

+
+ +
+ + + + + + + + diff --git a/authors.html b/authors.html new file mode 100644 index 0000000..e751958 --- /dev/null +++ b/authors.html @@ -0,0 +1,88 @@ + +Authors and Citation • murlib.core + + +
+
+ + + +
+
+
+
+

Authors and Citation

+
+ + +
  • +

    Murat Tasan. Author, maintainer. +

    +
    • +
+
+
+

Citation

+ +
+
+ + +

Tasan M (2024). +murlib.core: Core Utilities. +R package version 0.6.0. +

+ 
@Manual{,
+  title = {murlib.core: Core Utilities},
+  author = {Murat Tasan},
+  year = {2024},
+  note = {R package version 0.6.0},
+}
+ +
+ +
+ + + +
+

Developed by Murat Tasan.

+
+ +
+

Site built with pkgdown 2.1.0.

+
+ +
+ + + + + + + + diff --git a/bootstrap-toc.css b/bootstrap-toc.css new file mode 100644 index 0000000..5a85941 --- /dev/null +++ b/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/bootstrap-toc.js b/bootstrap-toc.js new file mode 100644 index 0000000..1cdd573 --- /dev/null +++ b/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/docsearch.css b/docsearch.css new file mode 100644 index 0000000..e5f1fe1 --- /dev/null +++ b/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/docsearch.js b/docsearch.js new file mode 100644 index 0000000..b35504c --- /dev/null +++ b/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/index.html b/index.html new file mode 100644 index 0000000..b3f9564 --- /dev/null +++ b/index.html @@ -0,0 +1,110 @@ + + + + + + + +Core Utilities • murlib.core + + + + + + + + + + + + +
    +
    + + + + +
    +
    +A collection of core utilities that I use frequently that are missing from 'core' R. +
    + + +
    + + +
    +

    +

    Developed by Murat Tasan.

    +
    + +
    +

    +

    Site built with pkgdown 2.1.0.

    +
    + +
    +
    + + + + + + + + diff --git a/link.svg b/link.svg new file mode 100644 index 0000000..88ad827 --- /dev/null +++ b/link.svg @@ -0,0 +1,12 @@ + + + + + + diff --git a/pkgdown.css b/pkgdown.css new file mode 100644 index 0000000..80ea5b8 --- /dev/null +++ b/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/pkgdown.js b/pkgdown.js new file mode 100644 index 0000000..6f0eee4 --- /dev/null +++ b/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/pkgdown.yml b/pkgdown.yml new file mode 100644 index 0000000..155f139 --- /dev/null +++ b/pkgdown.yml @@ -0,0 +1,5 @@ +pandoc: 3.1.13 +pkgdown: 2.1.0 +pkgdown_sha: ~ +articles: {} +last_built: 2024-09-12T10:10Z diff --git a/reference/add_class.html b/reference/add_class.html new file mode 100644 index 0000000..1c984fa --- /dev/null +++ b/reference/add_class.html @@ -0,0 +1,100 @@ + +Add (S3) class(es) to an object. — add_class • murlib.core + + +
    +
    + + + +
    +
    +
    +

    Add (S3) class(es) to an object.

    + + +
    + +
    +

    Add (S3) class(es) to an object.

    +
    + +
    + 
    prepend_class(x, cls = character(0), null = NULL)
+
+append_class(x, cls = character(0), null = NULL)
    +
    + +
    +

    Arguments

    + + +
    x
    +

    The object to which class(es) should be added.

    + + +
    cls
    +

    A vector of classes to be added.

    + + +
    null
    +

    Replace NULL with this val. If NULL, then NULL is returned (without a class).

    + +
    +
    +

    Value

    +

    The object with new class structure.

    +
    +
    +

    Details

    +

    The new class vector will be uniquified (while retaining order, so the first – left-to-right – of any duplicates is taken preferentially).

    +
    + +
    + +
    + + +
    +

    Developed by Murat Tasan.

    +
    + +
    +

    Site built with pkgdown 2.1.0.

    +
    + +
    + + + + + + + + diff --git a/reference/chunk.html b/reference/chunk.html new file mode 100644 index 0000000..eaf959a --- /dev/null +++ b/reference/chunk.html @@ -0,0 +1,122 @@ + +Chunk a vector into a list of vectors of roughly equal length. — chunk • murlib.core + + +
    +
    + + + +
    +
    +
    +

    Chunk a vector into a list of vectors of roughly equal length.

    + + +
    + +
    +

    Chunk a vector into a list of vectors of roughly equal length.

    +
    + +
    + 
    chunk(
+  x,
+  chunk_count = NULL,
+  chunk_max_length = NULL,
+  method = c("seq", "mod", "rand")
+)
+
+chunk_int(
+  n,
+  chunk_count = NULL,
+  chunk_max_length = NULL,
+  method = c("seq", "mod", "rand")
+)
    +
    + +
    +

    Arguments

    + + +
    x
    +

    The vector or list to be chunked.

    + + +
    method
    +

    The algorithm to use for chunking. +"seq" _seq_uentially chunks x. +"mod" creates chunks where original indices are alike after modulo arithmetic. +"rand" specifies that x should be uniformly and randomly distributed across chunks.

    + + +
    n
    +

    The number of integers to chunk (i.e. chunk the sequence 1:n).

    + + +
    count
    +

    The number of chunks desired.

    + + +
    max_length
    +

    The maximum desired length of any chunk.

    + +
    +
    +

    Value

    +

    For chunk, a list with x chunked across the list entries. +For chunk_int, a list with the values 1:n chunked across the list entries.

    +
    +
    +

    Details

    +

    Exactly one of n_chunks and max_chunk_size should be NULL (to specify both as non-NULL is an error).

    +
    + +
    + +
    + + +
    +

    Developed by Murat Tasan.

    +
    + +
    +

    Site built with pkgdown 2.1.0.

    +
    + +
    + + + + + + + + diff --git a/reference/dict.html b/reference/dict.html new file mode 100644 index 0000000..994937c --- /dev/null +++ b/reference/dict.html @@ -0,0 +1,99 @@ + +Create a uniquely-named list, i.e. a dict(ionary). — dict • murlib.core + + +
    +
    + + + +
    +
    +
    +

    Create a uniquely-named list, i.e. a dict(ionary).

    + + +
    + +
    +

    Create a uniquely-named list, i.e. a dict(ionary).

    +
    + +
    + 
    dict(...)
+
+is_dict(x)
    +
    + +
    +

    Arguments

    + + +
    ...
    +

    The dictionary elements and values; all elements must be named.

    + + +
    x
    +

    The object to test.

    + +
    +
    +

    Value

    +

    A new dictionary.

    +
    +
    +

    Details

    +

    A dictionary : +* all elements must be named +* all element names must be unique/distinct +* is always a list (even if length-0 ... this is distinct from NULL)

    +
    + +
    + +
    + + +
    +

    Developed by Murat Tasan.

    +
    + +
    +

    Site built with pkgdown 2.1.0.

    +
    + +
    + + + + + + + + diff --git a/reference/grapes-equals-equals-grapes.html b/reference/grapes-equals-equals-grapes.html new file mode 100644 index 0000000..6b74c86 --- /dev/null +++ b/reference/grapes-equals-equals-grapes.html @@ -0,0 +1,74 @@ + +Infix identical() — %===% • murlib.core + + +
    +
    + + + +
    +
    +
    +

    Infix identical()

    + + +
    + +
    +

    Infix identical()

    +
    + +
    + 
    l %===% r
    +
    + + +
    + +
    + + +
    +

    Developed by Murat Tasan.

    +
    + +
    +

    Site built with pkgdown 2.1.0.

    +
    + +
    + + + + + + + + diff --git a/reference/index.html b/reference/index.html new file mode 100644 index 0000000..51b5a2a --- /dev/null +++ b/reference/index.html @@ -0,0 +1,124 @@ + +Package index • murlib.core + + +
    +
    + + + +
    +
    +
    +

    Reference

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

    All functions

    +

    +
    +

    prepend_class() append_class()

    +

    Add (S3) class(es) to an object.

    +

    chunk() chunk_int()

    +

    Chunk a vector into a list of vectors of roughly equal length.

    +

    dict() is_dict()

    +

    Create a uniquely-named list, i.e. a dict(ionary).

    +

    `%===%`

    +

    Infix identical()

    +

    itself()

    +

    Returns the (first) argument unmodified.

    +

    logit()

    +

    Logit function.

    +

    matchval()

    +

    Match values to a reference.

    +

    nop()

    +

    NOP

    +

    `%!in%` `%notin%`

    +

    Not-in

    +

    null2() null_to()

    +

    Replace NULL

    +

    na2() nan2() inf2() na_to() nan_to() inf_to()

    +

    Coalesce special values in a vector.

    +

    sample_int() sample_from()

    +

    Sample (without the n=1 gotcha)

    +

    trailing_args()

    +

    The trailing CLI args

    +

    na_lgl na_int na_dbl na_chr na_date na_posixct

    +

    Typed NA values

    + + +
    + + +
    +

    Developed by Murat Tasan.

    +
    + +
    +

    Site built with pkgdown 2.1.0.

    +
    + +
    + + + + + + + + diff --git a/reference/itself.html b/reference/itself.html new file mode 100644 index 0000000..4b46428 --- /dev/null +++ b/reference/itself.html @@ -0,0 +1,78 @@ + +Returns the (first) argument unmodified. — itself • murlib.core + + +
    +
    + + + +
    +
    +
    +

    Returns the (first) argument unmodified.

    + + +
    + +
    +

    Returns the (first) argument unmodified.

    +
    + +
    + 
    itself(x, ...)
    +
    + +
    +

    Value

    +

    x. If x is missing, then NULL (invisibly).

    +
    + +
    + +
    + + +
    +

    Developed by Murat Tasan.

    +
    + +
    +

    Site built with pkgdown 2.1.0.

    +
    + +
    + + + + + + + + diff --git a/reference/logit.html b/reference/logit.html new file mode 100644 index 0000000..c460dd7 --- /dev/null +++ b/reference/logit.html @@ -0,0 +1,74 @@ + +Logit function. — logit • murlib.core + + +
    +
    + + + +
    +
    +
    +

    Logit function.

    + + +
    + +
    +

    Logit function.

    +
    + +
    + 
    logit(p, location = 0, scale = 1, lower.tail = TRUE, log.p = FALSE)
    +
    + + +
    + +
    + + +
    +

    Developed by Murat Tasan.

    +
    + +
    +

    Site built with pkgdown 2.1.0.

    +
    + +
    + + + + + + + + diff --git a/reference/matchval.html b/reference/matchval.html new file mode 100644 index 0000000..bb0fd3a --- /dev/null +++ b/reference/matchval.html @@ -0,0 +1,102 @@ + +Match values to a reference. — matchval • murlib.core + + +
    +
    + + + +
    +
    +
    +

    Match values to a reference.

    + + +
    + +
    +

    Wraps base::match to be a bit more useful.

    +
    + +
    + 
    matchval(query, from, to = seq_along(from), nomatch = NA, ...)
    +
    + +
    +

    Arguments

    + + +
    query
    +

    The vector of values to search for.

    + + +
    from
    +

    The vector of values that will be searched.

    + + +
    to
    +

    The vector of values that will be returned for matches.

    + + +
    nomatch
    +

    The value to be returned in case of no match.

    + + +
    ...
    +

    ignored; for future use.

    + +
    +
    +

    Value

    +

    A vector of values from to.

    +
    + +
    + +
    + + +
    +

    Developed by Murat Tasan.

    +
    + +
    +

    Site built with pkgdown 2.1.0.

    +
    + +
    + + + + + + + + diff --git a/reference/murlib.core-package.html b/reference/murlib.core-package.html new file mode 100644 index 0000000..9eb1a8a --- /dev/null +++ b/reference/murlib.core-package.html @@ -0,0 +1,75 @@ + +murlib.core: Core Utilities — murlib.core-package • murlib.core + + +
    +
    + + + +
    +
    +
    +

    murlib.core: Core Utilities

    + + +
    + +
    +

    A collection of core utilities that I use frequently that are missing from 'core' R.

    +
    + + +
    +

    Author

    +

    Maintainer: Murat Tasan mmuurr@gmail.com (ORCID)

    +
    + +
    + +
    + + +
    +

    Developed by Murat Tasan.

    +
    + +
    +

    Site built with pkgdown 2.1.0.

    +
    + +
    + + + + + + + + diff --git a/reference/nop.html b/reference/nop.html new file mode 100644 index 0000000..c69ff79 --- /dev/null +++ b/reference/nop.html @@ -0,0 +1,86 @@ + +NOP — nop • murlib.core + + +
    +
    + + + +
    +
    +
    +

    NOP

    + + +
    + +
    +

    NOP

    +
    + +
    + 
    nop(...)
    +
    + +
    +

    Arguments

    + + +
    ...
    +

    Anything; will always be ignored.

    + +
    +
    +

    Value

    +

    NULL (invisibly)

    +
    + +
    + +
    + + +
    +

    Developed by Murat Tasan.

    +
    + +
    +

    Site built with pkgdown 2.1.0.

    +
    + +
    + + + + + + + + diff --git a/reference/notin.html b/reference/notin.html new file mode 100644 index 0000000..1aca2ad --- /dev/null +++ b/reference/notin.html @@ -0,0 +1,80 @@ + +Not-in — notin • murlib.core + + +
    +
    + + + +
    +
    +
    +

    Not-in

    + + +
    + +
    +

    Not-in

    +
    + +
    + 
    l %!in% r
+
+l %notin% r
    +
    + +
    +

    Value

    +

    The logical inverse of %in%.

    +
    + +
    + +
    + + +
    +

    Developed by Murat Tasan.

    +
    + +
    +

    Site built with pkgdown 2.1.0.

    +
    + +
    + + + + + + + + diff --git a/reference/null2.html b/reference/null2.html new file mode 100644 index 0000000..077f588 --- /dev/null +++ b/reference/null2.html @@ -0,0 +1,92 @@ + +Replace NULL — null2 • murlib.core + + +
    +
    + + + +
    +
    +
    +

    Replace NULL

    + + +
    + +
    +

    Replace NULL

    +
    + +
    + 
    null2(x, replacement)
+
+null_to(x, replacement)
    +
    + +
    +

    Arguments

    + + +
    x
    +

    The value to test.

    + + +
    replacement
    +

    The new value in case x is NULL.

    + +
    +
    +

    Value

    +

    Either x or replacement.

    +
    + +
    + +
    + + +
    +

    Developed by Murat Tasan.

    +
    + +
    +

    Site built with pkgdown 2.1.0.

    +
    + +
    + + + + + + + + diff --git a/reference/replace_specials.html b/reference/replace_specials.html new file mode 100644 index 0000000..6d2c0bd --- /dev/null +++ b/reference/replace_specials.html @@ -0,0 +1,107 @@ + +Coalesce special values in a vector. — replace_specials • murlib.core + + +
    +
    + + + +
    +
    +
    +

    Coalesce special values in a vector.

    + + +
    + +
    +

    Coalesce special values in a vector.

    +
    + +
    + 
    na2(x, replacement)
+
+nan2(x, replacement)
+
+inf2(x, replacement)
+
+na_to(x, replacement)
+
+nan_to(x, replacement)
+
+inf_to(x, replacement)
    +
    + +
    +

    Arguments

    + + +
    x
    +

    The vector to be coalesced.

    + + +
    replacement
    +

    The replacement value.

    + +
    +
    +

    Value

    +

    A new vector with the special values replaced.

    +
    +
    +

    Details

    +

    replacement should typically be a scalar, but this isn't enforced. +If it's not a scalar, it'll be used in recycled fashion, but the recycling will +** only be applied at the replacement locations **, which is probably not +the desired effect.

    +
    + +
    + +
    + + +
    +

    Developed by Murat Tasan.

    +
    + +
    +

    Site built with pkgdown 2.1.0.

    +
    + +
    + + + + + + + + diff --git a/reference/safe_sample.html b/reference/safe_sample.html new file mode 100644 index 0000000..777faca --- /dev/null +++ b/reference/safe_sample.html @@ -0,0 +1,82 @@ + +Sample (without the n=1 gotcha) — safe_sample • murlib.core + + +
    +
    + + + +
    +
    +
    +

    Sample (without the n=1 gotcha)

    + + +
    + +
    +

    Sample (without the n=1 gotcha)

    +
    + +
    + 
    sample_int(
+  n,
+  size = n,
+  replace = FALSE,
+  prob = NULL,
+  useHash = (n > 1e+07 && !replace && is.null(prob) && size <= n/2)
+)
+
+sample_from(x, size = length(x), replace = FALSE, prob = NULL)
    +
    + + +
    + +
    + + +
    +

    Developed by Murat Tasan.

    +
    + +
    +

    Site built with pkgdown 2.1.0.

    +
    + +
    + + + + + + + + diff --git a/reference/trailing_args.html b/reference/trailing_args.html new file mode 100644 index 0000000..db72790 --- /dev/null +++ b/reference/trailing_args.html @@ -0,0 +1,74 @@ + +The trailing CLI args — trailing_args • murlib.core + + +
    +
    + + + +
    +
    +
    +

    The trailing CLI args

    + + +
    + +
    +

    The trailing CLI args

    +
    + +
    + 
    trailing_args()
    +
    + + +
    + +
    + + +
    +

    Developed by Murat Tasan.

    +
    + +
    +

    Site built with pkgdown 2.1.0.

    +
    + +
    + + + + + + + + diff --git a/reference/typed_na.html b/reference/typed_na.html new file mode 100644 index 0000000..9a4ff02 --- /dev/null +++ b/reference/typed_na.html @@ -0,0 +1,93 @@ + +Typed NA values — typed_na • murlib.core + + +
    +
    + + + +
    +
    +
    +

    Typed NA values

    + + +
    + +
    +

    Typed NA values

    +
    + +
    + 
    na_lgl
+
+na_int
+
+na_dbl
+
+na_chr
+
+na_date
+
+na_posixct
    +
    + +
    +

    Format

    +

    An object of class logical of length 1.

    +

    An object of class integer of length 1.

    +

    An object of class numeric of length 1.

    +

    An object of class character of length 1.

    +

    An object of class Date of length 1.

    +

    An object of class POSIXct (inherits from POSIXt) of length 1.

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