From a5ea1d953329db8213e131bc34f66c6cb0db71b3 Mon Sep 17 00:00:00 2001 From: realbp <72233714+realbp@users.noreply.github.com> Date: Wed, 27 Mar 2024 20:56:37 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20getwilds?= =?UTF-8?q?/cancerprof@fc5818d6600e52720d95ce8d3831575b73364731=20?= =?UTF-8?q?=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- 404.html | 119 ++++--- CONTRIBUTING.html | 107 ++++--- LICENSE-text.html | 104 +++--- LICENSE.html | 106 ++++--- articles/demographics-vignette.html | 125 +++++--- articles/incidence-vignette.html | 125 +++++--- articles/index.html | 99 +++--- articles/mortality-vignette.html | 125 +++++--- articles/risks-vignette.html | 125 +++++--- authors.html | 122 ++++--- bootstrap-toc.css | 60 ++++ bootstrap-toc.js | 159 ++++++++++ docsearch.css | 148 +++++++++ docsearch.js | 85 +++++ index.html | 119 ++++--- pkgdown.css | 384 +++++++++++++++++++++++ pkgdown.js | 172 ++++------ pkgdown.yml | 2 +- reference/cancerprof-package.html | 119 ++++--- reference/demo_crowding.html | 131 ++++---- reference/demo_education.html | 131 ++++---- reference/demo_food.html | 131 ++++---- reference/demo_income.html | 131 ++++---- reference/demo_insurance.html | 131 ++++---- reference/demo_language.html | 129 ++++---- reference/demo_mobility.html | 131 ++++---- reference/demo_population.html | 131 ++++---- reference/demo_poverty.html | 131 ++++---- reference/demo_svi.html | 131 ++++---- reference/demo_workforce.html | 130 ++++---- reference/incidence_cancer.html | 127 ++++---- reference/index.html | 288 +++++++++-------- reference/mortality_cancer.html | 127 ++++---- reference/pipe.html | 122 +++---- reference/risk_alcohol.html | 131 ++++---- reference/risk_colorectal_screening.html | 131 ++++---- reference/risk_diet_exercise.html | 131 ++++---- reference/risk_smoking.html | 135 ++++---- reference/risk_vaccines.html | 131 ++++---- reference/risk_women_health.html | 131 ++++---- 40 files changed, 3309 insertions(+), 1988 deletions(-) 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 pkgdown.css diff --git a/404.html b/404.html index e32a829..8ea3aad 100644 --- a/404.html +++ b/404.html @@ -4,92 +4,117 @@ - + Page not found (404) • cancerprof - - - + + + - + + - - Skip to contents + -
-
-
-

Page not found (404)

+ +
+ + + +
+
+
+

Page not found (404)

Content not found. Please use links in the navbar. -
+
+ + +
- + diff --git a/CONTRIBUTING.html b/CONTRIBUTING.html index d26d379..da701f6 100644 --- a/CONTRIBUTING.html +++ b/CONTRIBUTING.html @@ -1,53 +1,65 @@ -Contributing • cancerprofContributing • cancerprof - Skip to contents + -
-
-
-

Contributing

- Source: .github/CONTRIBUTING.md + + +
+
+
+

Contributing

@@ -82,22 +94,29 @@

Code of Conduct

-
+
+ - + diff --git a/LICENSE-text.html b/LICENSE-text.html index 03ce1f8..36bf38d 100644 --- a/LICENSE-text.html +++ b/LICENSE-text.html @@ -1,74 +1,94 @@ -License • cancerprofLicense • cancerprof - Skip to contents + -
-
-
-

License

+ +
+
+
+

License

YEAR: 2024
 COPYRIGHT HOLDER: cancerprof authors
-
+
+ - + diff --git a/LICENSE.html b/LICENSE.html index bfec384..0601809 100644 --- a/LICENSE.html +++ b/LICENSE.html @@ -1,53 +1,65 @@ -MIT License • cancerprofMIT License • cancerprof - Skip to contents + -
-
-
-

MIT License

- Source: LICENSE.md + + +
+
+
+

MIT License

@@ -58,21 +70,29 @@

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.

-
+
+ - + diff --git a/articles/demographics-vignette.html b/articles/demographics-vignette.html index 41d4fd0..475ae87 100644 --- a/articles/demographics-vignette.html +++ b/articles/demographics-vignette.html @@ -4,78 +4,92 @@ - - + Demographics • cancerprof - - - + + + - + + - - Skip to contents + -
- - + +
+ + -
-
-

Demographics

+
+
+
+

Demographics

Source: vignettes/demographics-vignette.Rmd -
demographics-vignette.Rmd
+ +
@@ -527,27 +541,34 @@

Workforce#> 3 District of Columbia 11001 7.1 14769 50 of 52

-
+
+ + + - + diff --git a/articles/incidence-vignette.html b/articles/incidence-vignette.html index e902a74..d8fde12 100644 --- a/articles/incidence-vignette.html +++ b/articles/incidence-vignette.html @@ -4,78 +4,92 @@ - - + incidence-vignette • cancerprof - - - + + + - + + - - Skip to contents + -
- - + +
+ + -
-
-

incidence-vignette

+
+
+
+

incidence-vignette

Source: vignettes/incidence-vignette.Rmd -
incidence-vignette.Rmd
+ +
@@ -202,27 +216,34 @@

Examples#> 3 <NA> NA NA NA

-
+
+ + + - + diff --git a/articles/index.html b/articles/index.html index 72a2193..7f8d450 100644 --- a/articles/index.html +++ b/articles/index.html @@ -1,52 +1,65 @@ -Articles • cancerprofArticles • cancerprof - Skip to contents + -
-
-
-

Articles

+ + +
+
+
+

Articles

@@ -62,21 +75,23 @@

All vignettes

Screening and Risk Factors
-
+
+ - + diff --git a/articles/mortality-vignette.html b/articles/mortality-vignette.html index 6bbc1ae..a2e2143 100644 --- a/articles/mortality-vignette.html +++ b/articles/mortality-vignette.html @@ -4,78 +4,92 @@ - - + mortality-vignette • cancerprof - - - + + + - + + - - Skip to contents + -
- - + +
+ + -
-
-

mortality-vignette

+
+
+
+

mortality-vignette

Source: vignettes/mortality-vignette.Rmd -
mortality-vignette.Rmd
+ +
@@ -187,27 +201,34 @@

Examples#> 3 3 2 9 36 falling -1.4 -2.0 -0.9

-
+
+ + + - + diff --git a/articles/risks-vignette.html b/articles/risks-vignette.html index e538500..7afb120 100644 --- a/articles/risks-vignette.html +++ b/articles/risks-vignette.html @@ -4,78 +4,92 @@ - - + Screening and Risk Factors • cancerprof - - - + + + - + + - - Skip to contents + -
- - + +
+ + -
-
-

Screening and Risk Factors

+
+
+
+

Screening and Risk Factors

Source: vignettes/risks-vignette.Rmd -
risks-vignette.Rmd
+ +
@@ -352,27 +366,34 @@

Risk Women’s Health#> 3 Texas 48000 46.4 39.6 53.3 318

-
+
+ + + - + diff --git a/authors.html b/authors.html index 358eabf..4a38326 100644 --- a/authors.html +++ b/authors.html @@ -1,95 +1,113 @@ -Authors and Citation • cancerprofAuthors and Citation • cancerprof - Skip to contents + -
-
-
-

Authors and Citation

-
+ + +
+
+
+
+

Authors

+
-
-

Authors

  • Brian Park. Author, maintainer.

+
+
+

Citation

+ Source: DESCRIPTION +
+
-
-

Citation

-

Source: DESCRIPTION

-

Park B (2024). +

Park B (2024). cancerprof: API Client for State Cancer Profiles. R package version 0.0.0.9000, https://github.com/getwilds/cancerprof.

- 
@Manual{,
+    
@Manual{,
   title = {cancerprof: API Client for State Cancer Profiles},
   author = {Brian Park},
   year = {2024},
   note = {R package version 0.0.0.9000},
   url = {https://github.com/getwilds/cancerprof},
 }

-
-
+
+ + - + 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 index 060d818..f0a126b 100644 --- a/index.html +++ b/index.html @@ -4,69 +4,86 @@ - - + API Client for State Cancer Profiles • cancerprof - - - + + + - + + - - Skip to contents + -
    -
    -
    + +
    + + + + +
    +
    +

    cancerprof

    @@ -90,7 +107,10 @@

    SupportFor questions, bugs, or feature requests, please reach out to Brian Park at , or open an issue on our issue tracker

    -
    +
    - + 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 index 5fccd9c..6f0eee4 100644 --- a/pkgdown.js +++ b/pkgdown.js @@ -2,30 +2,70 @@ (function($) { $(function() { - $('nav.navbar').headroom(); + $('.navbar-fixed-top').headroom(); - Toc.init({ - $nav: $("#toc"), - $scope: $("main h2, main h3, main h4, main h5, main h6") + $('body').css('padding-top', $('.navbar').height() + 10); + $(window).resize(function(){ + $('body').css('padding-top', $('.navbar').height() + 10); }); - if ($('#toc').length) { - $('body').scrollspy({ - target: '#toc', - offset: $("nav.navbar").outerHeight() + 1 - }); + $('[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; + } } - // Activate popovers - $('[data-bs-toggle="popover"]').popover({ - container: 'body', - html: true, - trigger: 'focus', - placement: "top", - sanitize: false, - }); + // 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); - $('[data-bs-toggle="tooltip"]').tooltip(); + // 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 --------------------------*/ @@ -38,7 +78,7 @@ if(ClipboardJS.isSupported()) { $(document).ready(function() { - var copyButton = ""; + var copyButton = ""; $("div.sourceCode").addClass("hasCopyButton"); @@ -49,108 +89,20 @@ $('.btn-copy-ex').tooltip({container: 'body'}); // Initialize clipboard: - var clipboard = new ClipboardJS('[data-clipboard-copy]', { + var clipboardBtnCopies = new ClipboardJS('[data-clipboard-copy]', { text: function(trigger) { return trigger.parentNode.textContent.replace(/\n#>[^\n]*/g, ""); } }); - clipboard.on('success', function(e) { + clipboardBtnCopies.on('success', function(e) { changeTooltipMessage(e.trigger, 'Copied!'); e.clearSelection(); }); - clipboard.on('error', function() { + clipboardBtnCopies.on('error', function() { changeTooltipMessage(e.trigger,'Press Ctrl+C or Command+C to copy'); }); - }); } - - /* Search marking --------------------------*/ - var url = new URL(window.location.href); - var toMark = url.searchParams.get("q"); - var mark = new Mark("main#main"); - if (toMark) { - mark.mark(toMark, { - accuracy: { - value: "complementary", - limiters: [",", ".", ":", "/"], - } - }); - } - - /* Search --------------------------*/ - /* Adapted from https://github.com/rstudio/bookdown/blob/2d692ba4b61f1e466c92e78fd712b0ab08c11d31/inst/resources/bs4_book/bs4_book.js#L25 */ - // Initialise search index on focus - var fuse; - $("#search-input").focus(async function(e) { - if (fuse) { - return; - } - - $(e.target).addClass("loading"); - var response = await fetch($("#search-input").data("search-index")); - var data = await response.json(); - - var options = { - keys: ["what", "text", "code"], - ignoreLocation: true, - threshold: 0.1, - includeMatches: true, - includeScore: true, - }; - fuse = new Fuse(data, options); - - $(e.target).removeClass("loading"); - }); - - // Use algolia autocomplete - var options = { - autoselect: true, - debug: true, - hint: false, - minLength: 2, - }; - var q; -async function searchFuse(query, callback) { - await fuse; - - var items; - if (!fuse) { - items = []; - } else { - q = query; - var results = fuse.search(query, { limit: 20 }); - items = results - .filter((x) => x.score <= 0.75) - .map((x) => x.item); - if (items.length === 0) { - items = [{dir:"Sorry 😿",previous_headings:"",title:"No results found.",what:"No results found.",path:window.location.href}]; - } - } - callback(items); -} - $("#search-input").autocomplete(options, [ - { - name: "content", - source: searchFuse, - templates: { - suggestion: (s) => { - if (s.title == s.what) { - return `${s.dir} >
    ${s.title}
    `; - } else if (s.previous_headings == "") { - return `${s.dir} >
    ${s.title}
    > ${s.what}`; - } else { - return `${s.dir} >
    ${s.title}
    > ${s.previous_headings} > ${s.what}`; - } - }, - }, - }, - ]).on('autocomplete:selected', function(event, s) { - window.location.href = s.path + "?q=" + q + "#" + s.id; - }); - }); })(window.jQuery || window.$) - - diff --git a/pkgdown.yml b/pkgdown.yml index 8b827bf..e640aff 100644 --- a/pkgdown.yml +++ b/pkgdown.yml @@ -6,5 +6,5 @@ articles: incidence-vignette: incidence-vignette.html mortality-vignette: mortality-vignette.html risks-vignette: risks-vignette.html -last_built: 2024-03-27T18:58Z +last_built: 2024-03-27T20:56Z diff --git a/reference/cancerprof-package.html b/reference/cancerprof-package.html index 9c225ae..216b657 100644 --- a/reference/cancerprof-package.html +++ b/reference/cancerprof-package.html @@ -1,88 +1,105 @@ -cancerprof: API Client for State Cancer Profiles — cancerprof-package • cancerprofcancerprof: API Client for State Cancer Profiles — cancerprof-package • cancerprof - Skip to contents + -
    -
    -
    -

    cancerprof: API Client for State Cancer Profiles

    - Source: R/cancerprof-package.R -
    cancerprof-package.Rd
    +
    +
    +
    + + + +
    +
    +
    +

    cancerprof: API Client for State Cancer Profiles

    + Source: R/cancerprof-package.R +
    -
    +

    An API Client for accessing data from State Cancer Profiles for programmable analysis.

    -
    -

    See also

    + -
    -

    Author

    +
    +

    Author

    Maintainer: Brian Park joon.brianpark@gmail.com (ORCID)

    -
    +
    + +
    -
    +

    Developed by Brian Park.

    -
    +

    Site built with pkgdown 2.0.7.

    -
    +
    + diff --git a/reference/demo_crowding.html b/reference/demo_crowding.html index cca4968..a82c67d 100644 --- a/reference/demo_crowding.html +++ b/reference/demo_crowding.html @@ -1,70 +1,81 @@ -Access to Crowding Data — demo_crowding • cancerprofAccess to Crowding Data — demo_crowding • cancerprof - Skip to contents + -
    -
    -
    -

    Access to Crowding Data

    - Source: R/demo-crowding.R -
    demo_crowding.Rd
    +
    +
    +
    + + + +
    +
    +
    +

    Access to Crowding Data

    + Source: R/demo-crowding.R +
    -
    +

    This function returns a data frame about crowding demographics from State Cancer Profiles.

    -
    -

    Usage

    + 
    demo_crowding(area, areatype, crowding, race)
    -
    -

    Arguments

    +
    +

    Arguments

    area

    A state/territory abbreviation or USA.

    @@ -92,15 +103,15 @@

    Arguments -

    Value

    +
    +

    Value

    A data frame with the following columns: Area, Area Code, Percent, Households, Rank.

    -
    -

    See also

    +
    +

    See also

    Other demographics: demo_education(), demo_food(), @@ -114,8 +125,8 @@

    See alsodemo_workforce()

    -
    -

    Examples

    +
    +

    Examples

    if (FALSE) {
 demo_crowding(
   area = "WA",
@@ -140,22 +151,26 @@ 
    Examples}
    -
    +
    + +

    -
    + diff --git a/reference/demo_education.html b/reference/demo_education.html index 200dbd4..da8d4cd 100644 --- a/reference/demo_education.html +++ b/reference/demo_education.html @@ -1,70 +1,81 @@ -Access to Education Data — demo_education • cancerprofAccess to Education Data — demo_education • cancerprof - Skip to contents + -
    -
    -
    -

    Access to Education Data

    - Source: R/demo-education.R -
    demo_education.Rd
    +
    +
    +
    + + + +
    +
    +
    +

    Access to Education Data

    + Source: R/demo-education.R +
    -
    +

    This function returns a data frame about education demographics from State Cancer Profiles.

    -
    -

    Usage

    + 
    demo_education(area, areatype, education, sex = NULL, race = NULL)
    -
    -

    Arguments

    +
    +

    Arguments

    area

    A state/territory abbreviation or USA.

    @@ -101,15 +112,15 @@

    Arguments -

    Value

    +
    +

    Value

    A data frame with the following columns: Area Type, Area Code, Percent, Households, Rank.

    -
    -

    See also

    +
    +

    See also

    Other demographics: demo_crowding(), demo_food(), @@ -123,8 +134,8 @@

    See alsodemo_workforce()

    -
    -

    Examples

    +
    +

    Examples

    if (FALSE) {
 demo_education(
   area = "wa",
@@ -149,22 +160,26 @@ 
    Examples}
    -
    +
    + +

    -
    + diff --git a/reference/demo_food.html b/reference/demo_food.html index 82b66b2..610420f 100644 --- a/reference/demo_food.html +++ b/reference/demo_food.html @@ -1,70 +1,81 @@ -Access to Food Insecurity Data — demo_food • cancerprofAccess to Food Insecurity Data — demo_food • cancerprof - Skip to contents + -
    -
    -
    -

    Access to Food Insecurity Data

    - Source: R/demo-food-access.R -
    demo_food.Rd
    +
    +
    +
    + + + +
    +
    +
    +

    Access to Food Insecurity Data

    + Source: R/demo-food-access.R +
    -
    +

    This function returns a data frame about food demographics from State Cancer Profiles.

    -
    -

    Usage

    + 
    demo_food(area, areatype, food, race = NULL)
    -
    -

    Arguments

    +
    +

    Arguments

    area

    A state/territory abbreviation or USA.

    @@ -87,15 +98,15 @@

    Arguments -

    Value

    +
    +

    Value

    A data frame with the following columns: Area Type, Area Code, Value, People.

    -
    -

    See also

    +
    +

    See also

    Other demographics: demo_crowding(), demo_education(), @@ -109,8 +120,8 @@

    See alsodemo_workforce()

    -
    -

    Examples

    +
    +

    Examples

    if (FALSE) {
 demo_food(
   area = "wa",
@@ -134,22 +145,26 @@ 
    Examples}
    -
    +
    + +

    -
    + diff --git a/reference/demo_income.html b/reference/demo_income.html index 60273e1..7478d41 100644 --- a/reference/demo_income.html +++ b/reference/demo_income.html @@ -1,70 +1,81 @@ -Access to Income Data — demo_income • cancerprofAccess to Income Data — demo_income • cancerprof - Skip to contents + -
    -
    -
    -

    Access to Income Data

    - Source: R/demo-income.R -
    demo_income.Rd
    +
    +
    +
    + + + +
    +
    +
    +

    Access to Income Data

    + Source: R/demo-income.R +
    -
    +

    This function returns a data frame about income demographics from State Cancer Profiles.

    -
    -

    Usage

    + 
    demo_income(area, areatype, income, race)
    -
    -

    Arguments

    +
    +

    Arguments

    area

    A state/territory abbreviation or USA.

    @@ -88,15 +99,15 @@

    Arguments -

    Value

    +
    +

    Value

    A data frame with the following columns: Area Type, Area Code, Dollars, Rank.

    -
    -

    See also

    +
    +

    See also

    Other demographics: demo_crowding(), demo_education(), @@ -110,8 +121,8 @@

    See alsodemo_workforce()

    -
    -

    Examples

    +
    +

    Examples

    if (FALSE) {
 demo_income(
   area = "wa",
@@ -136,22 +147,26 @@ 
    Examples}
    -
    +
    + +

    -
    + diff --git a/reference/demo_insurance.html b/reference/demo_insurance.html index dfefbe4..08b14df 100644 --- a/reference/demo_insurance.html +++ b/reference/demo_insurance.html @@ -1,70 +1,81 @@ -Access to Insurance Data — demo_insurance • cancerprofAccess to Insurance Data — demo_insurance • cancerprof - Skip to contents + -
    -
    -
    -

    Access to Insurance Data

    - Source: R/demo-insurance.R -
    demo_insurance.Rd
    +
    +
    +
    + + + +
    +
    +
    +

    Access to Insurance Data

    + Source: R/demo-insurance.R +
    -
    +

    This function returns a data frame about insurance demographics from State Cancer Profiles.

    -
    -

    Usage

    + 
    demo_insurance(area, areatype, insurance, sex, age, race = NULL)
    -
    -

    Arguments

    +
    +

    Arguments

    area

    A state/territory abbreviation or USA.

    @@ -125,15 +136,15 @@

    Arguments -

    Value

    +
    +

    Value

    A data frame with the following columns: Area Type, Area Code, Percent, People, Rank.

    -
    -

    See also

    +
    +

    See also

    Other demographics: demo_crowding(), demo_education(), @@ -147,8 +158,8 @@

    See alsodemo_workforce()

    -
    -

    Examples

    +
    +

    Examples

    if (FALSE) {
 demo_insurance(
   area = "usa",
@@ -177,22 +188,26 @@ 
    Examples}
    -
    +
    + +

    -
    + diff --git a/reference/demo_language.html b/reference/demo_language.html index 970931d..ca5f658 100644 --- a/reference/demo_language.html +++ b/reference/demo_language.html @@ -1,70 +1,81 @@ -Access to Non-English Language — demo_language • cancerprofAccess to Non-English Language — demo_language • cancerprof - Skip to contents + -
    -
    -
    -

    Access to Non-English Language

    - Source: R/demo-non-english-language.R -
    demo_language.Rd
    + + +
    +
    +
    +

    Access to Non-English Language

    + Source: R/demo-non-english-language.R +
    -
    +

    This function returns a data frame about language demographics from State Cancer Profiles.

    -
    -

    Usage

    + 
    demo_language(area, areatype, language)
    -
    -

    Arguments

    +
    +

    Arguments

    area

    A state/territory abbreviation or USA.

    @@ -81,15 +92,15 @@

    Arguments.

    -
    -

    Value

    +
    +

    Value

    A data frame with the following columns: Area Type, Area Code, Percent, Households, Rank.

    -
    -

    See also

    +
    +

    See also

    Other demographics: demo_crowding(), demo_education(), @@ -103,8 +114,8 @@

    See alsodemo_workforce()

    -
    -

    Examples

    +
    +

    Examples

    demo_language(
   area = "WA",
   areatype = "county",
@@ -219,22 +230,26 @@ 
    Examples#> 52          Puerto Rico 72001      NA         NA     <NA>
    -
    +
    + +
    -
    + diff --git a/reference/demo_mobility.html b/reference/demo_mobility.html index 1bfd525..00968bc 100644 --- a/reference/demo_mobility.html +++ b/reference/demo_mobility.html @@ -1,70 +1,81 @@ -Access to Mobility Data — demo_mobility • cancerprofAccess to Mobility Data — demo_mobility • cancerprof - Skip to contents + -
    -
    -
    -

    Access to Mobility Data

    - Source: R/demo-mobility.R -
    demo_mobility.Rd
    +
    +
    +
    + + + +
    +
    +
    +

    Access to Mobility Data

    + Source: R/demo-mobility.R +
    -
    +

    This function returns a data frame about mobility demographics from State Cancer Profiles.

    -
    -

    Usage

    + 
    demo_mobility(area, areatype, mobility)
    -
    -

    Arguments

    +
    +

    Arguments

    area

    A state/territory abbreviation or USA.

    @@ -85,15 +96,15 @@

    Arguments -

    Value

    +
    +

    Value

    A data frame with the following columns: Area Type, Area Code, Percent, People, Rank.

    -
    -

    See also

    +
    +

    See also

    Other demographics: demo_crowding(), demo_education(), @@ -107,8 +118,8 @@

    See alsodemo_workforce()

    -
    -

    Examples

    +
    +

    Examples

    if (FALSE) {
 demo_mobility(
   area = "WA",
@@ -130,22 +141,26 @@ 
    Examples}
    -
    +
    + +

    -
    + diff --git a/reference/demo_population.html b/reference/demo_population.html index 8cb89c3..3f394e3 100644 --- a/reference/demo_population.html +++ b/reference/demo_population.html @@ -1,70 +1,81 @@ -Access to Population Data — demo_population • cancerprofAccess to Population Data — demo_population • cancerprof - Skip to contents + -
    -
    -
    -

    Access to Population Data

    - Source: R/demo-population.R -
    demo_population.Rd
    +
    +
    +
    + + + +
    +
    +
    +

    Access to Population Data

    + Source: R/demo-population.R +
    -
    +

    This function returns a data frame about population from State Cancer Profiles.

    -
    -

    Usage

    + 
    demo_population(area, areatype, population, race = NULL, sex = NULL)
    -
    -

    Arguments

    +
    +

    Arguments

    area

    A state/territory abbreviation or USA.

    @@ -113,15 +124,15 @@

    Arguments -

    Value

    +
    +

    Value

    A data frame with the following columns: Area Type, Area Code, Percent, Households, Rank.

    -
    -

    See also

    +
    +

    See also

    Other demographics: demo_crowding(), demo_education(), @@ -135,8 +146,8 @@

    See alsodemo_workforce()

    -
    -

    Examples

    +
    +

    Examples

    if (FALSE) {
 demo_population(
   area = "WA",
@@ -163,22 +174,26 @@ 
    Examples}
    -
    +
    + +

    -
    + diff --git a/reference/demo_poverty.html b/reference/demo_poverty.html index 73b751e..3703630 100644 --- a/reference/demo_poverty.html +++ b/reference/demo_poverty.html @@ -1,70 +1,81 @@ -Access to Poverty Data — demo_poverty • cancerprofAccess to Poverty Data — demo_poverty • cancerprof - Skip to contents + -
    -
    -
    -

    Access to Poverty Data

    - Source: R/demo-poverty.R -
    demo_poverty.Rd
    +
    +
    +
    + + + +
    +
    +
    +

    Access to Poverty Data

    + Source: R/demo-poverty.R +
    -
    +

    This function returns a data frame about poverty demographics from State Cancer Profiles.

    -
    -

    Usage

    + 
    demo_poverty(area, areatype, poverty, race = NULL, sex = NULL)
    -
    -

    Arguments

    +
    +

    Arguments

    area

    A state/territory abbreviation or USA.

    @@ -102,15 +113,15 @@

    Arguments -

    Value

    +
    +

    Value

    A data frame with the following columns: Area Type, Area Code, Percent, Households, Rank.

    -
    -

    See also

    +
    +

    See also

    Other demographics: demo_crowding(), demo_education(), @@ -124,8 +135,8 @@

    See alsodemo_workforce()

    -
    -

    Examples

    +
    +

    Examples

    if (FALSE) {
 demo_poverty(
   area = "WA",
@@ -149,22 +160,26 @@ 
    Examples}
    -
    +
    + +

    -
    + diff --git a/reference/demo_svi.html b/reference/demo_svi.html index 32bd40b..47112f8 100644 --- a/reference/demo_svi.html +++ b/reference/demo_svi.html @@ -1,70 +1,81 @@ -Access to Social Vulnerability Index (SVI) Data — demo_svi • cancerprofAccess to Social Vulnerability Index (SVI) Data — demo_svi • cancerprof - Skip to contents + -
    -
    -
    -

    Access to Social Vulnerability Index (SVI) Data

    - Source: R/demo-svi.R -
    demo_svi.Rd
    +
    +
    +
    + + + +
    +
    +
    +

    Access to Social Vulnerability Index (SVI) Data

    + Source: R/demo-svi.R +
    -
    +

    This function returns a data frame about social vulnerability index (SVI) from State Cancer Profiles.

    -
    -

    Usage

    + 
    demo_svi(area, svi)
    -
    -

    Arguments

    +
    +

    Arguments

    area

    A state/territory abbreviation or USA.

    @@ -78,14 +89,14 @@

    Arguments -

    Value

    +
    +

    Value

    A data frame with the following columns: County, FIPS, Score.

    -
    -

    See also

    +
    +

    See also

    Other demographics: demo_crowding(), demo_education(), @@ -99,8 +110,8 @@

    See alsodemo_workforce()

    -
    -

    Examples

    +
    +

    Examples

    if (FALSE) {
 demo_svi(
   area = "WA",
@@ -119,22 +130,26 @@ 
    Examples}
    -
    +
    + +

    -
    + diff --git a/reference/demo_workforce.html b/reference/demo_workforce.html index 3c371bc..2b57b0c 100644 --- a/reference/demo_workforce.html +++ b/reference/demo_workforce.html @@ -1,67 +1,79 @@ -Access to Workforce Data — demo_workforce • cancerprofAccess to Workforce Data — demo_workforce • cancerprof - Skip to contents + -
    -
    -
    -

    Access to Workforce Data

    - Source: R/demo-workforce.R -
    demo_workforce.Rd
    +
    +
    +
    + + + +
    +
    +
    +

    Access to Workforce Data

    + Source: R/demo-workforce.R +
    -
    +

    This function returns a data frame from Workforce in State Cancer Profiles.

    -
    -

    Usage

    + 
    demo_workforce(area, areatype, workforce, race, sex)
    -
    -

    Arguments

    +
    +

    Arguments

    area

    A state/territory abbreviation or USA.

    @@ -96,15 +108,15 @@

    Arguments -

    Value

    +
    +

    Value

    A data frame with the following columns: Area Type, Area Code, Percent, People Unemployed, Rank.

    -
    -

    See also

    +
    +

    See also

    Other demographics: demo_crowding(), demo_education(), @@ -118,8 +130,8 @@

    See alsodemo_svi()

    -
    -

    Examples

    +
    +

    Examples

    if (FALSE) {
 demo_workforce(
   area = "WA",
@@ -147,22 +159,26 @@ 
    Examples}
    -
    +
    + +

    -
    + diff --git a/reference/incidence_cancer.html b/reference/incidence_cancer.html index 0de17a6..bdabcc1 100644 --- a/reference/incidence_cancer.html +++ b/reference/incidence_cancer.html @@ -1,70 +1,81 @@ -Access to Cancer Incident Data — incidence_cancer • cancerprofAccess to Cancer Incident Data — incidence_cancer • cancerprof - Skip to contents + -
    -
    -
    -

    Access to Cancer Incident Data

    - Source: R/incidence-cancer.R -
    incidence_cancer.Rd
    +
    +
    +
    + + + +
    +
    +
    +

    Access to Cancer Incident Data

    + Source: R/incidence-cancer.R +
    -
    +

    This function returns a data frame about cancer incidence from State Cancer Profiles.

    -
    -

    Usage

    + 
    incidence_cancer(area, areatype, cancer, race, sex, age, stage, year)
    -
    -

    Arguments

    +
    +

    Arguments

    area

    A state/territory abbreviation or USA.

    @@ -143,8 +154,8 @@

    Arguments -

    Value

    +
    +

    Value

    A data frame with the following columns: @@ -153,8 +164,8 @@

    Value

    -
    -

    Examples

    +
    +

    Examples

    if (FALSE) {
 incidence_cancer(
   area = "wa",
@@ -191,22 +202,26 @@ 
    Examples}
    -
    +

    + +
    -
    + diff --git a/reference/index.html b/reference/index.html index 2e228f7..2cb9543 100644 --- a/reference/index.html +++ b/reference/index.html @@ -1,176 +1,168 @@ -Function reference • cancerprofFunction reference • cancerprof - Skip to contents + -
    -
    -
    -

    Function reference

    -
    +
    +
    +
    -
    -

    All functions

    - - -
    - - - +
    +
    +
    +

    Reference

    +
    -
    - - demo_crowding() -
    -
    Access to Crowding Data
    -
    - - demo_education() -
    -
    Access to Education Data
    -
    - - demo_food() -
    -
    Access to Food Insecurity Data
    -
    - - demo_income() -
    -
    Access to Income Data
    -
    - - demo_insurance() -
    -
    Access to Insurance Data
    -
    - - demo_language() -
    -
    Access to Non-English Language
    -
    - - demo_mobility() -
    -
    Access to Mobility Data
    -
    - - demo_population() -
    -
    Access to Population Data
    -
    - - demo_poverty() -
    -
    Access to Poverty Data
    -
    - - demo_svi() -
    -
    Access to Social Vulnerability Index (SVI) Data
    -
    - - demo_workforce() -
    -
    Access to Workforce Data
    -
    - - incidence_cancer() -
    -
    Access to Cancer Incident Data
    -
    - - mortality_cancer() -
    -
    Access to Cancer Mortality Data
    -
    - - risk_alcohol() -
    -
    Access to Alcohol Screening and Risk Data
    -
    - - risk_colorectal_screening() -
    -
    Access to Colorectal Screening Data
    -
    - - risk_diet_exercise() -
    -
    Access to Diet & Exercise Screening Data
    -
    - - risk_smoking() -
    -
    Access to Smoking Data
    -
    - - risk_vaccines() -
    -
    Access to Vaccines Data
    -
    - - risk_women_health() -
    -
    Access to Women's Health Data
    -
    -
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +

    All functions

    +

    +
    +

    demo_crowding()

    +

    Access to Crowding Data

    +

    demo_education()

    +

    Access to Education Data

    +

    demo_food()

    +

    Access to Food Insecurity Data

    +

    demo_income()

    +

    Access to Income Data

    +

    demo_insurance()

    +

    Access to Insurance Data

    +

    demo_language()

    +

    Access to Non-English Language

    +

    demo_mobility()

    +

    Access to Mobility Data

    +

    demo_population()

    +

    Access to Population Data

    +

    demo_poverty()

    +

    Access to Poverty Data

    +

    demo_svi()

    +

    Access to Social Vulnerability Index (SVI) Data

    +

    demo_workforce()

    +

    Access to Workforce Data

    +

    incidence_cancer()

    +

    Access to Cancer Incident Data

    +

    mortality_cancer()

    +

    Access to Cancer Mortality Data

    +

    risk_alcohol()

    +

    Access to Alcohol Screening and Risk Data

    +

    risk_colorectal_screening()

    +

    Access to Colorectal Screening Data

    +

    risk_diet_exercise()

    +

    Access to Diet & Exercise Screening Data

    +

    risk_smoking()

    +

    Access to Smoking Data

    +

    risk_vaccines()

    +

    Access to Vaccines Data

    +

    risk_women_health()

    +

    Access to Women's Health Data

    + + +
    -
    +

    Developed by Brian Park.

    -
    +

    Site built with pkgdown 2.0.7.

    -
    +
    + diff --git a/reference/mortality_cancer.html b/reference/mortality_cancer.html index 0e86e6b..1377176 100644 --- a/reference/mortality_cancer.html +++ b/reference/mortality_cancer.html @@ -1,70 +1,81 @@ -Access to Cancer Mortality Data — mortality_cancer • cancerprofAccess to Cancer Mortality Data — mortality_cancer • cancerprof - Skip to contents + -
    -
    -
    -

    Access to Cancer Mortality Data

    - Source: R/mortality-cancer.R -
    mortality_cancer.Rd
    +
    +
    +
    + + + +
    +
    +
    +

    Access to Cancer Mortality Data

    + Source: R/mortality-cancer.R +
    -
    +

    This function returns a data frame about cancer mortality from State Cancer Profiles.

    -
    -

    Usage

    + 
    mortality_cancer(area, areatype, cancer, race, sex, age, year)
    -
    -

    Arguments

    +
    +

    Arguments

    area

    A state/territory abbreviation or USA.

    @@ -136,8 +147,8 @@

    Arguments -

    Value

    +
    +

    Value

    A data frame with the following columns: @@ -147,8 +158,8 @@

    Value

    -
    -

    Examples

    +
    +

    Examples

    if (FALSE) {
 mortality_cancer(
   area = "wa",
@@ -182,22 +193,26 @@ 
    Examples}
    -
    +

    + +
    -
    + diff --git a/reference/pipe.html b/reference/pipe.html index 932111b..f3f00dc 100644 --- a/reference/pipe.html +++ b/reference/pipe.html @@ -1,67 +1,79 @@ -Pipe operator — %>% • cancerprofPipe operator — %>% • cancerprof - Skip to contents + -
    -
    -
    -

    Pipe operator

    - Source: R/utils-pipe.R -
    pipe.Rd
    +
    +
    +
    + + + +
    +
    +
    +

    Pipe operator

    + Source: R/utils-pipe.R +
    -
    +

    See magrittr::%>% for details.

    -
    -

    Usage

    + 
    lhs %>% rhs
    -
    -

    Arguments

    +
    +

    Arguments

    lhs

    A value or the magrittr placeholder.

    @@ -70,29 +82,33 @@

    Arguments -

    Value

    +
    +

    Value

    The result of calling rhs(lhs).

    -

    +
    + +
    -
    +

    Developed by Brian Park.

    -
    +

    Site built with pkgdown 2.0.7.

    -
    +
    + diff --git a/reference/risk_alcohol.html b/reference/risk_alcohol.html index 56c5328..d0236b0 100644 --- a/reference/risk_alcohol.html +++ b/reference/risk_alcohol.html @@ -1,70 +1,81 @@ -Access to Alcohol Screening and Risk Data — risk_alcohol • cancerprofAccess to Alcohol Screening and Risk Data — risk_alcohol • cancerprof - Skip to contents + -
    -
    -
    -

    Access to Alcohol Screening and Risk Data

    - Source: R/risk-alcohol.R -
    risk_alcohol.Rd
    +
    +
    +
    + + + +
    +
    +
    +

    Access to Alcohol Screening and Risk Data

    + Source: R/risk-alcohol.R +
    -
    +

    This function returns a data frame about alcohol risks from State Cancer Profiles.

    -
    -

    Usage

    + 
    risk_alcohol(alcohol, race, sex)
    -
    -

    Arguments

    +
    +

    Arguments

    alcohol

    The only permissible value is `paste("binge drinking (4+ drinks on one occasion for women,", @@ -88,16 +99,16 @@

    Arguments -

    Value

    +
    +

    Value

    A data frame with the following columns: Area Type, Area Code, Percent, Lower 95% CI, Upper 95% CI, Number of Respondents.

    -
    -

    See also

    +
    +

    See also

    Other risks: risk_colorectal_screening(), risk_diet_exercise(), @@ -106,8 +117,8 @@

    See alsorisk_women_health()

    -
    -

    Examples

    +
    +

    Examples

    if (FALSE) {
 risk_alcohol(
   alcohol = paste(
@@ -120,22 +131,26 @@ 
    Examples}
    -
    +
    + +

    -
    + diff --git a/reference/risk_colorectal_screening.html b/reference/risk_colorectal_screening.html index 8ab8baf..c7f299c 100644 --- a/reference/risk_colorectal_screening.html +++ b/reference/risk_colorectal_screening.html @@ -1,70 +1,81 @@ -Access to Colorectal Screening Data — risk_colorectal_screening • cancerprofAccess to Colorectal Screening Data — risk_colorectal_screening • cancerprof - Skip to contents + -
    -
    -
    -

    Access to Colorectal Screening Data

    - Source: R/risk-colorectal-screening.R -
    risk_colorectal_screening.Rd
    +
    +
    +
    + + + +
    +
    +
    +

    Access to Colorectal Screening Data

    + Source: R/risk-colorectal-screening.R +
    -
    +

    This function returns a data frame about colorectal screening from State Cancer Profiles.

    -
    -

    Usage

    + 
    risk_colorectal_screening(screening, race = NULL, sex = NULL, area = NULL)
    -
    -

    Arguments

    +
    +

    Arguments

    screening

    One of the following values:

    • "ever had fobt, ages 50-75"

    • "guidance sufficient crc, ages 50-75"

      • @@ -95,15 +106,15 @@

      Arguments -

      Value

      +
      +

      Value

      A data frame with the following columns: Area Type, Area Code, Percent, People Unemployed, Rank.

      -
      -

      See also

      +
      +

      See also

      Other risks: risk_alcohol(), risk_diet_exercise(), @@ -112,8 +123,8 @@

      See alsorisk_women_health()

      -
      -

      Examples

      +
      +

      Examples

      if (FALSE) {
 risk_colorectal_screening(
   screening = "home blood stool test in the past year, ages 45-75",
@@ -133,22 +144,26 @@ 
      Examples}
      -
      +
      + +

    -
    + diff --git a/reference/risk_diet_exercise.html b/reference/risk_diet_exercise.html index 9f454c9..180837f 100644 --- a/reference/risk_diet_exercise.html +++ b/reference/risk_diet_exercise.html @@ -1,70 +1,81 @@ -Access to Diet & Exercise Screening Data — risk_diet_exercise • cancerprofAccess to Diet & Exercise Screening Data — risk_diet_exercise • cancerprof - Skip to contents + -
    -
    -
    -

    Access to Diet & Exercise Screening Data

    - Source: R/risk-diet-exercise.R -
    risk_diet_exercise.Rd
    +
    +
    +
    + + + +
    +
    +
    +

    Access to Diet & Exercise Screening Data

    + Source: R/risk-diet-exercise.R +
    -
    +

    This function returns a data frame about diet and exercise risk from State Cancer Profiles.

    -
    -

    Usage

    + 
    risk_diet_exercise(diet_exercise, race, sex)
    -
    -

    Arguments

    +
    +

    Arguments

    diet_exercise

    One of the following values:

    • "bmi is healthy, ages 20+"

    • "bmi is obese, ages 20+"

      • @@ -93,16 +104,16 @@

      Arguments -

      Value

      +
      +

      Value

      A data frame with the following columns: Area Type, Area Code, Percent, Lower 95% CI, Upper 95% CI, Number of Respondents.

      -
      -

      See also

      +
      +

      See also

      Other risks: risk_alcohol(), risk_colorectal_screening(), @@ -111,8 +122,8 @@

      See alsorisk_women_health()

      -
      -

      Examples

      +
      +

      Examples

      if (FALSE) {
 risk_diet_exercise(
   diet_exercise = "bmi is healthy, ages 20+",
@@ -127,22 +138,26 @@ 
      Examples}
      -
      +
      + +

    -
    + diff --git a/reference/risk_smoking.html b/reference/risk_smoking.html index 46343dc..561f459 100644 --- a/reference/risk_smoking.html +++ b/reference/risk_smoking.html @@ -1,70 +1,81 @@ -Access to Smoking Data — risk_smoking • cancerprofAccess to Smoking Data — risk_smoking • cancerprof - Skip to contents + -
    -
    -
    -

    Access to Smoking Data

    - Source: R/risk-smoking.R -
    risk_smoking.Rd
    +
    +
    +
    + + + +
    +
    +
    +

    Access to Smoking Data

    + Source: R/risk-smoking.R +
    -
    +

    This function returns a data frame about smoking risks from State Cancer Profiles.

    -
    -

    Usage

    + 
    risk_smoking(smoking, race = NULL, sex = NULL, datatype = NULL, area = NULL)
    -
    -

    Arguments

    +
    +

    Arguments

    smoking

    The only permissible values are

    + diff --git a/reference/risk_vaccines.html b/reference/risk_vaccines.html index c49ecf9..7539eff 100644 --- a/reference/risk_vaccines.html +++ b/reference/risk_vaccines.html @@ -1,70 +1,81 @@ -Access to Vaccines Data — risk_vaccines • cancerprofAccess to Vaccines Data — risk_vaccines • cancerprof - Skip to contents + -
    -
    -
    -

    Access to Vaccines Data

    - Source: R/risk-vaccines.R -
    risk_vaccines.Rd
    +
    +
    +
    + + + +
    +
    +
    +

    Access to Vaccines Data

    + Source: R/risk-vaccines.R +
    -
    +

    This function returns a data frame about vaccines risks from State Cancer Profiles.

    -
    -

    Usage

    + 
    risk_vaccines(vaccine, sex)
    -
    -

    Arguments

    +
    +

    Arguments

    vaccine

    One of the following values:

    • "percent with up to date hpv vaccination coverage, ages 13-15",

    • "percent with up to date hpv vaccination coverage, ages 13-17".

      • @@ -78,16 +89,16 @@

      Arguments -

      Value

      +
      +

      Value

      A data frame with the following columns: Area Type, Area Code, Percent, Lower 95% CI, Upper 95% CI, Number of Respondents.

      -
      -

      See also

      +
      +

      See also

      Other risks: risk_alcohol(), risk_colorectal_screening(), @@ -96,8 +107,8 @@

      See alsorisk_women_health()

      -
      -

      Examples

      +
      +

      Examples

      if (FALSE) {
 risk_vaccines(
   vaccine = "percent with up to date hpv vaccination coverage, ages 13-15",
@@ -111,22 +122,26 @@ 
      Examples}
      -
      +
      + +

    -
    + diff --git a/reference/risk_women_health.html b/reference/risk_women_health.html index 311eb95..4533ba8 100644 --- a/reference/risk_women_health.html +++ b/reference/risk_women_health.html @@ -1,65 +1,76 @@ -Access to Women's Health Data — risk_women_health • cancerprofAccess to Women's Health Data — risk_women_health • cancerprof - Skip to contents + -
    -
    -
    -

    Access to Women's Health Data

    - Source: R/risk-womens-health.R -
    risk_women_health.Rd
    +
    +
    +
    + + + +
    +
    +
    +

    Access to Women's Health Data

    + Source: R/risk-womens-health.R +
    -
    +

    This function returns a data frame about women's health risks from State Cancer Profiles.

    -
    -

    Usage

    + 
    risk_women_health(
   women_health,
   race,
@@ -68,8 +79,8 @@ 
    Usage
 )
    -
    -

    Arguments

    +
    +

    Arguments

    women_health

    One of the following values:

    • "mammogram in past 2 years, ages 50-74"

    • "mammogram in past 2 years, ages 40+"

      • @@ -97,15 +108,15 @@

      Arguments -

      Value

      +
      +

      Value

      A data frame with the following columns: Area Type, Area Code, Percent, People Unemployed, Rank.

      -
      -

      See also

      +
      +

      See also

      Other risks: risk_alcohol(), risk_colorectal_screening(), @@ -114,8 +125,8 @@

      See alsorisk_vaccines()

      -
      -

      Examples

      +
      +

      Examples

      if (FALSE) {
 risk_women_health(
   women_health = "mammogram in past 2 years, ages 50-74",
@@ -137,22 +148,26 @@ 
      Examples}
      -
      +
      + +

    -
    +