From 74a66412af82ef986bcabf6d43c7fafaa3a26dc5 Mon Sep 17 00:00:00 2001 From: Rob Baker Date: Mon, 12 Aug 2024 16:17:25 -0600 Subject: [PATCH 1/7] This should keep it from hiting github too much . . .won't hit github to check for updates on build, etc. just during interactive sessions. --- R/zzz.R | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/R/zzz.R b/R/zzz.R index d4309a4..d67ea9d 100644 --- a/R/zzz.R +++ b/R/zzz.R @@ -2,8 +2,10 @@ #if internet access is available, check for updated packages: #check for github packages that need updating - if(is_online()){ - .update_git_repos() + if(is_online()) { + if (interactive()) { + .update_git_repos() + } } else { packageStartupMessage("Warning: You are offline. Cannot check for package updates.\n") } From 2cedc6098c281293c78deee3bbc8cda97bc66919 Mon Sep 17 00:00:00 2001 From: Rob Baker Date: Mon, 19 Aug 2024 08:16:42 -0600 Subject: [PATCH 2/7] update paper.md to include additional author --- paper.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/paper.md b/paper.md index 431ad29..e5626bf 100644 --- a/paper.md +++ b/paper.md @@ -35,6 +35,9 @@ authors: orcid: 0000-0003-1439-2204 equal-contrib: true affiliation: 1 + - name: Carl Boettiger + orcid: 0000-0002-1642-628X + affiliation: 5 - name: Judd M. Patterson orcid: 0000-0002-0951-7917 equal-contrib: true @@ -52,7 +55,9 @@ affiliations: index: 3 - name: Student Conservation Association, USA index: 4 -date: 24 July 2024 + - name: University of California, Berkeley, USA + index: 5 +date: 19 August 2024 bibliography: paper.bib editor_options: markdown: From e15ae451fa8827b61621958fcf33212b08b0a64e Mon Sep 17 00:00:00 2001 From: Rob Baker Date: Mon, 19 Aug 2024 11:23:33 -0600 Subject: [PATCH 3/7] update version to 0.1.0 --- DESCRIPTION | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/DESCRIPTION b/DESCRIPTION index 24e6e2a..672fde1 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,6 +1,6 @@ Package: NPSdataverse Title: Tools and Packages for Data and Metadata Manipulation -Version: 0.0.2 +Version: 0.1.0 Authors@R: c( person(given="Robert", family="Baker", email="robert_baker@nps.gov", role = c("aut", "cre"), From 9880e67fbcc83dd74f49c57632507e9c1036e11a Mon Sep 17 00:00:00 2001 From: Rob Baker Date: Mon, 19 Aug 2024 11:23:59 -0600 Subject: [PATCH 4/7] Update version; update about github API rate limits (changes to reduce these) --- NEWS.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/NEWS.md b/NEWS.md index d40210e..4d594e4 100644 --- a/NEWS.md +++ b/NEWS.md @@ -1,10 +1,15 @@ -# NPSdataverse 0.0.2 +# NPSdataverse 0.1.0 + +2024-08-19 +* Reduce github.com API rate limits by only hitting API in interactive session. 2024-07-26 * Updated license from MIT to CC0. * Start paper.md for JOSS * Add paper.bib for JOSS +# NPSdataverse 0.0.2 + 2024-01-02 * Added function ability to load NPSdataverse (using library()) when offline From ff8418e9c717df555bae8789d064b3d699211607 Mon Sep 17 00:00:00 2001 From: Rob Baker Date: Mon, 19 Aug 2024 11:24:33 -0600 Subject: [PATCH 5/7] Add alt text to figures --- README.Rmd | 14 ++++++++++++++ README.md | 6 +++--- 2 files changed, 17 insertions(+), 3 deletions(-) diff --git a/README.Rmd b/README.Rmd index ee2189b..42eba5a 100644 --- a/README.Rmd +++ b/README.Rmd @@ -14,8 +14,16 @@ knitr::opts_chunk$set( ``` # NPSdataverse + ```{r echo=FALSE, fig.align="center"} +#| fig.alt: > +#| Image diagraming NPSdataverse and its consituent packages using hexicons +#| A hexicon of NPSdataverse points to the hexicons for the 4 NPS-maintained +#| packages that load with the NPSdataverse: QCkit, EMLeditor, DPchecker, and +#| NPSutils. The key external packages EML and EMLassemblyline that also load +#| are included in a text box. knitr::include_graphics("man/figures/NPSdataverse_overview.jpg") +#![alt text]("man/figures/NPSdataverse_overview.jpg") ``` NPSdataverse loads a suite of R packages for creating, manipulating, and accessing data packages including interacting with DataStore. This is an early version of the NPSdataverse. Please request enhancements and bug fixes through [Issues](https://github.com/nationalparkservice/NPSdataverse/issues). @@ -77,12 +85,18 @@ If you are you are creating a data package and need to generate EML metadata mak After loading NPSdataverse, from within Rstudio select the "File" menu. Select "New File" from the drop down menu and choose "R Markdown". In the dialog box that pops up, select "From Template" and then click on the template labelled "Editable_EML_Creation_Workflow" and click "OK". ```{r echo=FALSE, out.width='45%', fig.align="center"} +#| fig.alt: > +#| A screenshot with highlights indicating how to access the EML script +#| This figure shows step 1. knitr::include_graphics("man/figures/open_rmd.png") ``` ```{r echo=FALSE, out.width='45%', fig.show='hold', fig.align='center'} +#| fig.alt: > +#| A screenshot with highlights indicating how to access the EML script +#| This figure shows step 2. knitr::include_graphics("man/figures/EMLtemplate.png") ``` diff --git a/README.md b/README.md index 8d98889..2c79809 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ # NPSdataverse - +Image diagraming NPSdataverse and its consituent packages using hexicons A hexicon of NPSdataverse points to the hexicons for the 4 NPS-maintained packages that load with the NPSdataverse: QCkit, EMLeditor, DPchecker, and NPSutils. The key external packages EML and EMLassemblyline that also load are included in a text box. NPSdataverse loads a suite of R packages for creating, manipulating, and accessing data packages including interacting with DataStore. This is an early version of the NPSdataverse. Please request enhancements and bug @@ -76,9 +76,9 @@ Select “New File” from the drop down menu and choose “R Markdown”. In the dialog box that pops up, select “From Template” and then click on the template labelled “Editable_EML_Creation_Workflow” and click “OK”. - +A screenshot with highlights indicating how to access the EML script This figure shows step 1. - +A screenshot with highlights indicating how to access the EML script This figure shows step 2. This will open a new file on that you can edit to generate EML metadata for your data package. See the [web pages associated with From 19036edd2ca4e76336cd3833b7249fa80aceea8f Mon Sep 17 00:00:00 2001 From: Rob Baker Date: Mon, 19 Aug 2024 11:24:54 -0600 Subject: [PATCH 6/7] created using usethis::use_pkgdown --- _pkgdown.yml | 4 ++++ 1 file changed, 4 insertions(+) create mode 100644 _pkgdown.yml diff --git a/_pkgdown.yml b/_pkgdown.yml new file mode 100644 index 0000000..48e011e --- /dev/null +++ b/_pkgdown.yml @@ -0,0 +1,4 @@ +url: https://github.com/nationalparkservice/NPSdataverse +template: + bootstrap: 5 + From 0bffeea2ba5c2e22124270b46f44c2068a5fd5db Mon Sep 17 00:00:00 2001 From: Rob Baker Date: Mon, 19 Aug 2024 11:25:10 -0600 Subject: [PATCH 7/7] updated via pkgdown --- .Rbuildignore | 3 + .gitignore | 1 + docs/404.html | 116 ++---- docs/LICENSE-text.html | 96 ++--- docs/LICENSE.html | 97 ++--- docs/articles/NPSdataverse.html | 123 +++--- docs/articles/index.html | 93 ++--- docs/authors.html | 121 +++--- docs/bootstrap-toc.css | 60 --- docs/bootstrap-toc.js | 159 -------- docs/docsearch.css | 148 ------- docs/docsearch.js | 85 ---- docs/index.html | 127 +++--- docs/news/index.html | 109 ++--- docs/paper.html | 96 ++--- docs/pkgdown.css | 384 ------------------ docs/pkgdown.js | 176 +++++--- docs/pkgdown.yml | 8 +- docs/reference/NPSdataverse_packages.html | 110 ++--- docs/reference/detach_NPSdataverse.html | 122 +++--- .../dot-print_cust_package_deps.html | 126 +++--- docs/reference/dot-update_git_repos.html | 114 +++--- docs/reference/index.html | 143 +++---- docs/reference/is_online.html | 126 +++--- docs/sitemap.xml | 64 +-- 25 files changed, 833 insertions(+), 1974 deletions(-) delete mode 100644 docs/bootstrap-toc.css delete mode 100644 docs/bootstrap-toc.js delete mode 100644 docs/docsearch.css delete mode 100644 docs/docsearch.js delete mode 100644 docs/pkgdown.css diff --git a/.Rbuildignore b/.Rbuildignore index 9055c18..ca8575e 100644 --- a/.Rbuildignore +++ b/.Rbuildignore @@ -2,3 +2,6 @@ ^\.Rproj\.user$ ^LICENSE\.md$ ^README\.Rmd$ +^_pkgdown\.yml$ +^docs$ +^pkgdown$ diff --git a/.gitignore b/.gitignore index c833a2c..138866d 100644 --- a/.gitignore +++ b/.gitignore @@ -3,3 +3,4 @@ .RData .Ruserdata inst/doc +docs diff --git a/docs/404.html b/docs/404.html index 83692c9..68ba20f 100644 --- a/docs/404.html +++ b/docs/404.html @@ -4,103 +4,73 @@ - + Page not found (404) • NPSdataverse - - - - - - - + + + + + - - - -
-
-
- +
+
+
Content not found. Please use links in the navbar. -
- - - +
- -
- - + diff --git a/docs/LICENSE-text.html b/docs/LICENSE-text.html index c299d5a..d55509b 100644 --- a/docs/LICENSE-text.html +++ b/docs/LICENSE-text.html @@ -1,82 +1,58 @@ -License • NPSdataverse - - -
-
-
-
YEAR: 2022
 COPYRIGHT HOLDER: NPSdataverse authors
 
-
+
- +
- - -
-
- - diff --git a/docs/LICENSE.html b/docs/LICENSE.html index 08641dc..48217ac 100644 --- a/docs/LICENSE.html +++ b/docs/LICENSE.html @@ -1,52 +1,36 @@ -CC0 1.0 Universal • NPSdataverse - - -
-
-
- - diff --git a/docs/articles/NPSdataverse.html b/docs/articles/NPSdataverse.html index f52d174..ff2f769 100644 --- a/docs/articles/NPSdataverse.html +++ b/docs/articles/NPSdataverse.html @@ -4,111 +4,84 @@ - + NPSdataverse • NPSdataverse - - - - - - - - + + + + + - - + + Skip to contents -
-
-
- +
-
- - + diff --git a/docs/articles/index.html b/docs/articles/index.html index 4a4d0be..c61137e 100644 --- a/docs/articles/index.html +++ b/docs/articles/index.html @@ -1,79 +1,60 @@ -Articles • NPSdataverse - - -
-
-
-

All vignettes

-

+
NPSdataverse
-
-
+
-
+
+ - - diff --git a/docs/authors.html b/docs/authors.html index 9c81fbe..6b21a5b 100644 --- a/docs/authors.html +++ b/docs/authors.html @@ -1,56 +1,40 @@ -Authors and Citation • NPSdataverse - - -
-
-
-
- - - +
+

Authors

+
  • Robert Baker. Author, maintainer.

    @@ -64,46 +48,41 @@

    Authors and Citation

-
-
-

Citation

- Source: DESCRIPTION -
-
+
+

Citation

+

Source: DESCRIPTION

-

Baker R, Patterson J, DeVivo J (2024). +

Baker R, Patterson J, DeVivo J (2024). NPSdataverse: Tools and Packages for Data and Metadata Manipulation. -R package version 0.0.2, https://github.com/nationalparkservice/NPSdataverse. +R package version 0.1.0, https://github.com/nationalparkservice/NPSdataverse.

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

    `, then `

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

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

    NPSdataverse loads a suite of R packages for creating, manipulating, and accessing data packages including interacting with DataStore. This is an early version of the NPSdataverse. Please request enhancements and bug fixes through Issues.

    +

    Image diagraming NPSdataverse and its consituent packages using hexicons A hexicon of NPSdataverse points to the hexicons for the 4 NPS-maintained packages that load with the NPSdataverse: QCkit, EMLeditor, DPchecker, and NPSutils. The key external packages EML and EMLassemblyline that also load are included in a text box. NPSdataverse loads a suite of R packages for creating, manipulating, and accessing data packages including interacting with DataStore. This is an early version of the NPSdataverse. Please request enhancements and bug fixes through Issues.

    Installation

    @@ -130,26 +109,23 @@

    Trouble shooting installation

    Updating NPSdataverse packages

    -

    Many of the NPSdataverse packages are in a phase of rapid development. When you load the NPSdataverse (using library(NPSdataverse)), if you are online, NPSdataverse will check for new versions of the packages stored on GitHub (all the packages except r/EML). NPSdataverse will tell you if all your packages are up to date. Conversely if any of the NPSdataverse packages need to be updated, NPSdataverse will indicate which packages need updating and how to perform the updates. If you do not get any notices about whether your packages are up to date or not, then the NPSdataverse package itself needs to be updated. See Installation for instructions on how to update the NPSdataverse package.

    +

    Many of the NPSdataverse packages are in a phase of rapid development. When you load the NPSdataverse (using library(NPSdataverse)), if you are online, NPSdataverse will check for new versions of the packages stored on GitHub (all the packages except r/EML). NPSdataverse will tell you if all your packages are up to date. Conversely if any of the NPSdataverse packages need to be updated, NPSdataverse will indicate which packages need updating and how to perform the updates. If you do not get any notices about whether your packages are up to date or not, then the NPSdataverse package itself needs to be updated. See Installation for instructions on how to update the NPSdataverse package.

    Creating data packages

    If you are you are creating a data package and need to generate EML metadata make sure all of your .csv data files are in a single folder.

    After loading NPSdataverse, from within Rstudio select the “File” menu. Select “New File” from the drop down menu and choose “R Markdown”. In the dialog box that pops up, select “From Template” and then click on the template labelled “Editable_EML_Creation_Workflow” and click “OK”.

    -

    -

    +

    A screenshot with highlights indicating how to access the EML script This figure shows step 1.

    +

    A screenshot with highlights indicating how to access the EML script This figure shows step 2.

    This will open a new file on that you can edit to generate EML metadata for your data package. See the web pages associated with EMLeditor for additional information, instructions, and examples.

    -
    - - -
    - - + diff --git a/docs/news/index.html b/docs/news/index.html index 70cd7d1..3c4d57a 100644 --- a/docs/news/index.html +++ b/docs/news/index.html @@ -1,97 +1,78 @@ -Changelog • NPSdataverse - - -
    -
    -
    - +
    +
    +
    - +

    NPSdataverse 0.1.0

    +

    2024-08-19 * Reduce github.com API rate limits by only hitting API in interactive session.

    2024-07-26 * Updated license from MIT to CC0. * Start paper.md for JOSS * Add paper.bib for JOSS

    +
    +
    +

    NPSdataverse 0.0.2

    2024-01-02

    • Added function ability to load NPSdataverse (using library()) when offline
    • Now dynamically checks for github username rather than hardcoding in NPS
    • Fixed operands so that updates actually get checked
    - +

    NPSdataverse 0.0.1

    2023-09-12

    • updated version to be in line with forthcoming versioning guidance
    • updated documentation to assist in install/updating
    • updated updateR.R to tell the user not only when data packages are out of date but also when they are all up to date upon loading NPSdataverse.
    - +

    NPSdataverse 0.0.0.9000

    • Added a NEWS.md file to track changes to the package.
    -
    +
    - +
    - -
    -
    - - diff --git a/docs/paper.html b/docs/paper.html index a1c30ae..3a685e0 100644 --- a/docs/paper.html +++ b/docs/paper.html @@ -1,52 +1,36 @@ -Summary • NPSdataverse - - -
    -
    -
    - - diff --git a/docs/pkgdown.css b/docs/pkgdown.css deleted file mode 100644 index 80ea5b8..0000000 --- a/docs/pkgdown.css +++ /dev/null @@ -1,384 +0,0 @@ -/* Sticky footer */ - -/** - * Basic idea: https://philipwalton.github.io/solved-by-flexbox/demos/sticky-footer/ - * Details: https://github.com/philipwalton/solved-by-flexbox/blob/master/assets/css/components/site.css - * - * .Site -> body > .container - * .Site-content -> body > .container .row - * .footer -> footer - * - * Key idea seems to be to ensure that .container and __all its parents__ - * have height set to 100% - * - */ - -html, body { - height: 100%; -} - -body { - position: relative; -} - -body > .container { - display: flex; - height: 100%; - flex-direction: column; -} - -body > .container .row { - flex: 1 0 auto; -} - -footer { - margin-top: 45px; - padding: 35px 0 36px; - border-top: 1px solid #e5e5e5; - color: #666; - display: flex; - flex-shrink: 0; -} -footer p { - margin-bottom: 0; -} -footer div { - flex: 1; -} -footer .pkgdown { - text-align: right; -} -footer p { - margin-bottom: 0; -} - -img.icon { - float: right; -} - -/* Ensure in-page images don't run outside their container */ -.contents img { - max-width: 100%; - height: auto; -} - -/* Fix bug in bootstrap (only seen in firefox) */ -summary { - display: list-item; -} - -/* Typographic tweaking ---------------------------------*/ - -.contents .page-header { - margin-top: calc(-60px + 1em); -} - -dd { - margin-left: 3em; -} - -/* Section anchors ---------------------------------*/ - -a.anchor { - display: none; - margin-left: 5px; - width: 20px; - height: 20px; - - background-image: url(./link.svg); - background-repeat: no-repeat; - background-size: 20px 20px; - background-position: center center; -} - -h1:hover .anchor, -h2:hover .anchor, -h3:hover .anchor, -h4:hover .anchor, -h5:hover .anchor, -h6:hover .anchor { - display: inline-block; -} - -/* Fixes for fixed navbar --------------------------*/ - -.contents h1, .contents h2, .contents h3, .contents h4 { - padding-top: 60px; - margin-top: -40px; -} - -/* Navbar submenu --------------------------*/ - -.dropdown-submenu { - position: relative; -} - -.dropdown-submenu>.dropdown-menu { - top: 0; - left: 100%; - margin-top: -6px; - margin-left: -1px; - border-radius: 0 6px 6px 6px; -} - -.dropdown-submenu:hover>.dropdown-menu { - display: block; -} - -.dropdown-submenu>a:after { - display: block; - content: " "; - float: right; - width: 0; - height: 0; - border-color: transparent; - border-style: solid; - border-width: 5px 0 5px 5px; - border-left-color: #cccccc; - margin-top: 5px; - margin-right: -10px; -} - -.dropdown-submenu:hover>a:after { - border-left-color: #ffffff; -} - -.dropdown-submenu.pull-left { - float: none; -} - -.dropdown-submenu.pull-left>.dropdown-menu { - left: -100%; - margin-left: 10px; - border-radius: 6px 0 6px 6px; -} - -/* Sidebar --------------------------*/ - -#pkgdown-sidebar { - margin-top: 30px; - position: -webkit-sticky; - position: sticky; - top: 70px; -} - -#pkgdown-sidebar h2 { - font-size: 1.5em; - margin-top: 1em; -} - -#pkgdown-sidebar h2:first-child { - margin-top: 0; -} - -#pkgdown-sidebar .list-unstyled li { - margin-bottom: 0.5em; -} - -/* bootstrap-toc tweaks ------------------------------------------------------*/ - -/* All levels of nav */ - -nav[data-toggle='toc'] .nav > li > a { - padding: 4px 20px 4px 6px; - font-size: 1.5rem; - font-weight: 400; - color: inherit; -} - -nav[data-toggle='toc'] .nav > li > a:hover, -nav[data-toggle='toc'] .nav > li > a:focus { - padding-left: 5px; - color: inherit; - border-left: 1px solid #878787; -} - -nav[data-toggle='toc'] .nav > .active > a, -nav[data-toggle='toc'] .nav > .active:hover > a, -nav[data-toggle='toc'] .nav > .active:focus > a { - padding-left: 5px; - font-size: 1.5rem; - font-weight: 400; - color: inherit; - border-left: 2px solid #878787; -} - -/* Nav: second level (shown on .active) */ - -nav[data-toggle='toc'] .nav .nav { - display: none; /* Hide by default, but at >768px, show it */ - padding-bottom: 10px; -} - -nav[data-toggle='toc'] .nav .nav > li > a { - padding-left: 16px; - font-size: 1.35rem; -} - -nav[data-toggle='toc'] .nav .nav > li > a:hover, -nav[data-toggle='toc'] .nav .nav > li > a:focus { - padding-left: 15px; -} - -nav[data-toggle='toc'] .nav .nav > .active > a, -nav[data-toggle='toc'] .nav .nav > .active:hover > a, -nav[data-toggle='toc'] .nav .nav > .active:focus > a { - padding-left: 15px; - font-weight: 500; - font-size: 1.35rem; -} - -/* orcid ------------------------------------------------------------------- */ - -.orcid { - font-size: 16px; - color: #A6CE39; - /* margins are required by official ORCID trademark and display guidelines */ - margin-left:4px; - margin-right:4px; - vertical-align: middle; -} - -/* Reference index & topics ----------------------------------------------- */ - -.ref-index th {font-weight: normal;} - -.ref-index td {vertical-align: top; min-width: 100px} -.ref-index .icon {width: 40px;} -.ref-index .alias {width: 40%;} -.ref-index-icons .alias {width: calc(40% - 40px);} -.ref-index .title {width: 60%;} - -.ref-arguments th {text-align: right; padding-right: 10px;} -.ref-arguments th, .ref-arguments td {vertical-align: top; min-width: 100px} -.ref-arguments .name {width: 20%;} -.ref-arguments .desc {width: 80%;} - -/* Nice scrolling for wide elements --------------------------------------- */ - -table { - display: block; - overflow: auto; -} - -/* Syntax highlighting ---------------------------------------------------- */ - -pre, code, pre code { - background-color: #f8f8f8; - color: #333; -} -pre, pre code { - white-space: pre-wrap; - word-break: break-all; - overflow-wrap: break-word; -} - -pre { - border: 1px solid #eee; -} - -pre .img, pre .r-plt { - margin: 5px 0; -} - -pre .img img, pre .r-plt img { - background-color: #fff; -} - -code a, pre a { - color: #375f84; -} - -a.sourceLine:hover { - text-decoration: none; -} - -.fl {color: #1514b5;} -.fu {color: #000000;} /* function */ -.ch,.st {color: #036a07;} /* string */ -.kw {color: #264D66;} /* keyword */ -.co {color: #888888;} /* comment */ - -.error {font-weight: bolder;} -.warning {font-weight: bolder;} - -/* Clipboard --------------------------*/ - -.hasCopyButton { - position: relative; -} - -.btn-copy-ex { - position: absolute; - right: 0; - top: 0; - visibility: hidden; -} - -.hasCopyButton:hover button.btn-copy-ex { - visibility: visible; -} - -/* headroom.js ------------------------ */ - -.headroom { - will-change: transform; - transition: transform 200ms linear; -} -.headroom--pinned { - transform: translateY(0%); -} -.headroom--unpinned { - transform: translateY(-100%); -} - -/* mark.js ----------------------------*/ - -mark { - background-color: rgba(255, 255, 51, 0.5); - border-bottom: 2px solid rgba(255, 153, 51, 0.3); - padding: 1px; -} - -/* vertical spacing after htmlwidgets */ -.html-widget { - margin-bottom: 10px; -} - -/* fontawesome ------------------------ */ - -.fab { - font-family: "Font Awesome 5 Brands" !important; -} - -/* don't display links in code chunks when printing */ -/* source: https://stackoverflow.com/a/10781533 */ -@media print { - code a:link:after, code a:visited:after { - content: ""; - } -} - -/* Section anchors --------------------------------- - Added in pandoc 2.11: https://github.com/jgm/pandoc-templates/commit/9904bf71 -*/ - -div.csl-bib-body { } -div.csl-entry { - clear: both; -} -.hanging-indent div.csl-entry { - margin-left:2em; - text-indent:-2em; -} -div.csl-left-margin { - min-width:2em; - float:left; -} -div.csl-right-inline { - margin-left:2em; - padding-left:1em; -} -div.csl-indent { - margin-left: 2em; -} diff --git a/docs/pkgdown.js b/docs/pkgdown.js index 6f0eee4..9757bf9 100644 --- a/docs/pkgdown.js +++ b/docs/pkgdown.js @@ -2,83 +2,43 @@ (function($) { $(function() { - $('.navbar-fixed-top').headroom(); + $('nav.navbar').headroom(); - $('body').css('padding-top', $('.navbar').height() + 10); - $(window).resize(function(){ - $('body').css('padding-top', $('.navbar').height() + 10); + Toc.init({ + $nav: $("#toc"), + $scope: $("main h2, main h3, main h4, main h5, main h6") }); - $('[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); + if ($('#toc').length) { + $('body').scrollspy({ + target: '#toc', + offset: $("nav.navbar").outerHeight() + 1 + }); } - for (var i = 0; i < haystack.length; i++) { - if (needle[i] != haystack[i]) - return(i); - } + // Activate popovers + $('[data-bs-toggle="popover"]').popover({ + container: 'body', + html: true, + trigger: 'focus', + placement: "top", + sanitize: false, + }); - return(haystack.length); - } + $('[data-bs-toggle="tooltip"]').tooltip(); /* Clipboard --------------------------*/ function changeTooltipMessage(element, msg) { - var tooltipOriginalTitle=element.getAttribute('data-original-title'); - element.setAttribute('data-original-title', msg); + var tooltipOriginalTitle=element.getAttribute('data-bs-original-title'); + element.setAttribute('data-bs-original-title', msg); $(element).tooltip('show'); - element.setAttribute('data-original-title', tooltipOriginalTitle); + element.setAttribute('data-bs-original-title', tooltipOriginalTitle); } if(ClipboardJS.isSupported()) { $(document).ready(function() { - var copyButton = ""; + var copyButton = ""; $("div.sourceCode").addClass("hasCopyButton"); @@ -89,20 +49,106 @@ $('.btn-copy-ex').tooltip({container: 'body'}); // Initialize clipboard: - var clipboardBtnCopies = new ClipboardJS('[data-clipboard-copy]', { + var clipboard = new ClipboardJS('[data-clipboard-copy]', { text: function(trigger) { return trigger.parentNode.textContent.replace(/\n#>[^\n]*/g, ""); } }); - clipboardBtnCopies.on('success', function(e) { + clipboard.on('success', function(e) { changeTooltipMessage(e.trigger, 'Copied!'); e.clearSelection(); }); - clipboardBtnCopies.on('error', function() { + clipboard.on('error', function(e) { 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/docs/pkgdown.yml b/docs/pkgdown.yml index e72dbe9..6ba25f2 100644 --- a/docs/pkgdown.yml +++ b/docs/pkgdown.yml @@ -1,7 +1,9 @@ pandoc: 3.1.11 -pkgdown: 2.0.9 +pkgdown: 2.1.0 pkgdown_sha: ~ articles: NPSdataverse: NPSdataverse.html -last_built: 2024-07-26T15:29Z - +last_built: 2024-08-19T17:22Z +urls: + reference: https://github.com/nationalparkservice/NPSdataverse/reference + article: https://github.com/nationalparkservice/NPSdataverse/articles diff --git a/docs/reference/NPSdataverse_packages.html b/docs/reference/NPSdataverse_packages.html index 6f80b27..f5d74d9 100644 --- a/docs/reference/NPSdataverse_packages.html +++ b/docs/reference/NPSdataverse_packages.html @@ -1,94 +1,74 @@ -List all packages imported by NPSdataverse — NPSdataverse_packages • NPSdataverse - - -
    -
    -
    - +
    +
    +
    -
    +

    List all packages imported by NPSdataverse

    -
    +
    +

    Usage

    NPSdataverse_packages()
    -
    -

    Examples

    +
    +

    Examples

    NPSdataverse_packages()
     #>  [1] "cli"             "crayon"          "DPchecker"       "EML"            
     #>  [5] "EMLassemblyline" "EMLeditor"       "NPSutils"        "QCkit"          
     #>  [9] "rstudioapi"      "utils"           "remotes"        
     
    -
    - -
    +
    -
    +
    + - - diff --git a/docs/reference/detach_NPSdataverse.html b/docs/reference/detach_NPSdataverse.html index 934264e..65e7cfc 100644 --- a/docs/reference/detach_NPSdataverse.html +++ b/docs/reference/detach_NPSdataverse.html @@ -1,99 +1,77 @@ -Detach all loaded packages — detach_NPSdataverse • NPSdataverse - - -
    -
    -
    - +
    +
    +
    -
    +

    Detach all loaded packages

    -
    +
    +

    Usage

    detach_NPSdataverse()
    -
    -

    Value

    - - -

    invisilble

    +
    +

    Value

    +

    invisilble

    -
    -

    Examples

    -
    if (FALSE) {
    +    
    +

    Examples

    +
    if (FALSE) { # \dontrun{
     detach_NPSdataverse()
    -}
    +} # }
     
    -
    - -
    +
    -
    +
    + - - diff --git a/docs/reference/dot-print_cust_package_deps.html b/docs/reference/dot-print_cust_package_deps.html index 2fa1f93..1e0a4cc 100644 --- a/docs/reference/dot-print_cust_package_deps.html +++ b/docs/reference/dot-print_cust_package_deps.html @@ -1,106 +1,86 @@ -Custom print function for github repos to update — .print_cust_package_deps • NPSdataverse - - -
    -
    -
    - +
    +
    +
    -
    +

    formats print table for custom printing package dependencies in need to updating. Derived from remotes:::print.package_deps().

    -
    +
    +

    Usage

    .print_cust_package_deps(x, show_ok = FALSE, ...)
    -
    -

    Arguments

    -
    x
    +
    +

    Arguments

    + + +
    x

    dataframe. Output from NPSvers_update.

    -
    show_ok
    +
    show_ok

    logical.

    -
    ...
    +
    ...
    -
    -

    Value

    - - -

    printed text to console

    +
    +

    Value

    +

    printed text to console

    -
    - -
    +
    -
    +
    + - - diff --git a/docs/reference/dot-update_git_repos.html b/docs/reference/dot-update_git_repos.html index 58480ab..c75f7de 100644 --- a/docs/reference/dot-update_git_repos.html +++ b/docs/reference/dot-update_git_repos.html @@ -1,92 +1,70 @@ -Update info for git repos in NPSdataverse — .update_git_repos • NPSdataverse - - -
    -
    -
    - +
    +
    +
    -
    +

    .update_git_repos() determines which of the NPSdataverse packages from github need to be updated and provides instructions on how to do so.

    -
    +
    +

    Usage

    .update_git_repos()
    -
    -

    Value

    - - -

    dataframe

    +
    +

    Value

    +

    dataframe

    -
    - -
    +
    -
    +
    + - - diff --git a/docs/reference/index.html b/docs/reference/index.html index 7905e15..d8aaae0 100644 --- a/docs/reference/index.html +++ b/docs/reference/index.html @@ -1,92 +1,83 @@ -Function reference • NPSdataverse - - -
    -
    -
    - +
    +
    +
    - - - - - - - -
    -

    All functions

    -

    -
    -

    detach_NPSdataverse()

    -

    Detach all loaded packages

    -

    is_online()

    -

    Check internet connectivity

    -

    NPSdataverse_packages()

    -

    List all packages imported by NPSdataverse

    - - -
    +
    +

    All functions

    + + -
    + + +
    -
    -

    Site built with pkgdown 2.0.9.

    + -
    +
    + - - diff --git a/docs/reference/is_online.html b/docs/reference/is_online.html index b2e331f..dd9f23a 100644 --- a/docs/reference/is_online.html +++ b/docs/reference/is_online.html @@ -1,104 +1,84 @@ -Check internet connectivity — is_online • NPSdataverse - - -
    -
    -
    - +
    +
    +
    -
    +

    Checks whether the system can ping github.com. Adapted from:https://stackoverflow.com/questions/5076593/how-to-determine-if-you-have-an-internet-connection-in-r

    -
    +
    +

    Usage

    is_online(site = "https://github.com/")
    -
    -

    Arguments

    -
    site
    +
    +

    Arguments

    + + +
    site

    string defaults to https://github.com

    -
    -

    Value

    - - -

    logical

    +
    +

    Value

    +

    logical

    -
    -

    Examples

    +
    +

    Examples

    is_online()
     #> [1] TRUE
     
    -
    - -
    +
    -
    +
    + - - diff --git a/docs/sitemap.xml b/docs/sitemap.xml index 5b75e02..f2a112b 100644 --- a/docs/sitemap.xml +++ b/docs/sitemap.xml @@ -1,48 +1,18 @@ - - - - /404.html - - - /articles/index.html - - - /articles/NPSdataverse.html - - - /authors.html - - - /index.html - - - /LICENSE-text.html - - - /LICENSE.html - - - /news/index.html - - - /paper.html - - - /reference/detach_NPSdataverse.html - - - /reference/dot-print_cust_package_deps.html - - - /reference/dot-update_git_repos.html - - - /reference/index.html - - - /reference/is_online.html - - - /reference/NPSdataverse_packages.html - + +https://github.com/nationalparkservice/NPSdataverse/404.html +https://github.com/nationalparkservice/NPSdataverse/articles/index.html +https://github.com/nationalparkservice/NPSdataverse/articles/NPSdataverse.html +https://github.com/nationalparkservice/NPSdataverse/authors.html +https://github.com/nationalparkservice/NPSdataverse/index.html +https://github.com/nationalparkservice/NPSdataverse/LICENSE-text.html +https://github.com/nationalparkservice/NPSdataverse/LICENSE.html +https://github.com/nationalparkservice/NPSdataverse/news/index.html +https://github.com/nationalparkservice/NPSdataverse/paper.html +https://github.com/nationalparkservice/NPSdataverse/reference/detach_NPSdataverse.html +https://github.com/nationalparkservice/NPSdataverse/reference/dot-print_cust_package_deps.html +https://github.com/nationalparkservice/NPSdataverse/reference/dot-update_git_repos.html +https://github.com/nationalparkservice/NPSdataverse/reference/index.html +https://github.com/nationalparkservice/NPSdataverse/reference/is_online.html +https://github.com/nationalparkservice/NPSdataverse/reference/NPSdataverse_packages.html +