From 43b835ab6a19b43c6e11017bdb585af6a2678b54 Mon Sep 17 00:00:00 2001 From: Michael Sumner Date: Fri, 31 May 2024 09:36:17 +1000 Subject: [PATCH] convert Pages to gha --- .Rbuildignore | 3 +- .github/.gitignore | 1 + .github/workflows/pkgdown.yaml | 50 ++++ DESCRIPTION | 2 +- docs/authors.html | 131 --------- docs/docsearch.css | 148 ---------- docs/docsearch.js | 85 ------ docs/index.html | 165 ----------- docs/link.svg | 12 - docs/news/index.html | 149 ---------- docs/pkgdown.css | 236 ---------------- docs/pkgdown.js | 115 -------- docs/pkgdown.yml | 5 - docs/reference/altimetry.html | 191 ------------- docs/reference/amps_files.html | 224 --------------- docs/reference/argo_files.html | 159 ----------- docs/reference/bom_tmax_daily_files.html | 144 ---------- docs/reference/cmip5_files.html | 144 ---------- docs/reference/fsle_files.html | 150 ---------- docs/reference/ghrsst.html | 161 ----------- docs/reference/index.html | 239 ---------------- docs/reference/ncep2_files.html | 176 ------------ docs/reference/nsidc.html | 236 ---------------- docs/reference/oisst.html | 199 ------------- docs/reference/raadfiles-admin.html | 247 ---------------- docs/reference/raadfiles-package.html | 150 ---------- docs/reference/rema_8m_files.html | 198 ------------- docs/reference/smap.html | 148 ---------- docs/reference/srtm.html | 175 ------------ docs/reference/thelist.html | 343 ----------------------- docs/reference/topography-files.html | 258 ----------------- 31 files changed, 54 insertions(+), 4590 deletions(-) create mode 100644 .github/.gitignore create mode 100644 .github/workflows/pkgdown.yaml delete mode 100644 docs/authors.html delete mode 100644 docs/docsearch.css delete mode 100644 docs/docsearch.js delete mode 100644 docs/index.html delete mode 100644 docs/link.svg delete mode 100644 docs/news/index.html delete mode 100644 docs/pkgdown.css delete mode 100644 docs/pkgdown.js delete mode 100644 docs/pkgdown.yml delete mode 100644 docs/reference/altimetry.html delete mode 100644 docs/reference/amps_files.html delete mode 100644 docs/reference/argo_files.html delete mode 100644 docs/reference/bom_tmax_daily_files.html delete mode 100644 docs/reference/cmip5_files.html delete mode 100644 docs/reference/fsle_files.html delete mode 100644 docs/reference/ghrsst.html delete mode 100644 docs/reference/index.html delete mode 100644 docs/reference/ncep2_files.html delete mode 100644 docs/reference/nsidc.html delete mode 100644 docs/reference/oisst.html delete mode 100644 docs/reference/raadfiles-admin.html delete mode 100644 docs/reference/raadfiles-package.html delete mode 100644 docs/reference/rema_8m_files.html delete mode 100644 docs/reference/smap.html delete mode 100644 docs/reference/srtm.html delete mode 100644 docs/reference/thelist.html delete mode 100644 docs/reference/topography-files.html diff --git a/.Rbuildignore b/.Rbuildignore index b7c97bc..5e371ab 100644 --- a/.Rbuildignore +++ b/.Rbuildignore @@ -3,4 +3,5 @@ ^README\.Rmd$ ^README-.*\.png$ ^data-raw$ -docs/ \ No newline at end of file +docs/ +^\.github$ diff --git a/.github/.gitignore b/.github/.gitignore new file mode 100644 index 0000000..2d19fc7 --- /dev/null +++ b/.github/.gitignore @@ -0,0 +1 @@ +*.html diff --git a/.github/workflows/pkgdown.yaml b/.github/workflows/pkgdown.yaml new file mode 100644 index 0000000..c9f0165 --- /dev/null +++ b/.github/workflows/pkgdown.yaml @@ -0,0 +1,50 @@ +# Workflow derived from https://github.com/r-lib/actions/tree/v2/examples +# Need help debugging build failures? Start at https://github.com/r-lib/actions#where-to-find-help +on: + push: + branches: [main, master] + pull_request: + branches: [main, master] + release: + types: [published] + workflow_dispatch: + +name: pkgdown + +permissions: read-all + +jobs: + pkgdown: + runs-on: ubuntu-latest + # Only restrict concurrency for non-PR jobs + concurrency: + group: pkgdown-${{ github.event_name != 'pull_request' || github.run_id }} + env: + GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }} + permissions: + contents: write + steps: + - uses: actions/checkout@v4 + + - uses: r-lib/actions/setup-pandoc@v2 + + - uses: r-lib/actions/setup-r@v2 + with: + use-public-rspm: true + + - uses: r-lib/actions/setup-r-dependencies@v2 + with: + extra-packages: any::pkgdown, local::. + needs: website + + - name: Build site + run: pkgdown::build_site_github_pages(new_process = FALSE, install = FALSE) + shell: Rscript {0} + + - name: Deploy to GitHub pages 🚀 + if: github.event_name != 'pull_request' + uses: JamesIves/github-pages-deploy-action@v4.5.0 + with: + clean: false + branch: gh-pages + folder: docs diff --git a/DESCRIPTION b/DESCRIPTION index 0e60bfd..f355077 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,6 +1,6 @@ Package: raadfiles Title: File Database Management for 'raadtools' -Version: 0.1.4.9006 +Version: 0.1.4.9007 Authors@R: c( person("Michael D.","Sumner", role = c("aut", "cre"), email = "michael.sumner@aad.gov.au"), person("Ben", "Raymond", role = "ctb"), diff --git a/docs/authors.html b/docs/authors.html deleted file mode 100644 index 84b40ac..0000000 --- a/docs/authors.html +++ /dev/null @@ -1,131 +0,0 @@ - - - - - - - - -Authors • raadfiles - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- - - -
- -
-
-
-

Authors

-
- -
    -
  • -

    Michael D. Sumner. Author, maintainer. -

    -
    • -
  • -

    Ben Raymond. Contributor. -

    -
    • -
- -
- -
- - -
-
-

Developed by Michael D. Sumner.

-
- -
-

Site built with pkgdown 1.3.0.

-
-
-
- - - - - - 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 deleted file mode 100644 index 95f3e66..0000000 --- a/docs/index.html +++ /dev/null @@ -1,165 +0,0 @@ - - - - - - - -File Database Management for 'raadtools' • raadfiles - - - - - - - - - -
-
- - - -
-
- - - - - -
-

-raadfiles

-

The goal of raadfiles is to manage information about the large collection of files used by raadtools, and related systems.

-
-

-Motivation

-

You have a huge set of files you need to access regularly, and the information about those files is the first thing you need.

-

This project aims to speed up and help you control the following:

-
    -
  • raw file listing
    • -
  • seaching file names for patterns
    • -
  • caching metadata extracted from the files
    • -
-

The overall goal is to help you write code to access and manipulate the data in those files. This is a natural complement to schemes that automatically obtain files and build file collections such as raadsync but can be used for other collections as well.

-
-
-

-Set up

-
    -
  1. Get a huge file collection. (You probably have lots, but see https://github.com/rOpensci/bowerbird for a possible way forward if not).
    2. -
  2. Install raadfiles.
    3. -
  3. Set up the automated file listing and caching mechanism.
    4. -
-
-
-

-Install raadfiles

-
## install.packages("remotes")
-remotes::install_github("AustralianAntarcticDivision/raadfiles")
-
-
-

-Set up the automated file listing and caching mechanism

-
    -
  1. An R script to list all the files and save to a cache, use raw text or R workspace saveRDS or feather or an actual database.
    2. -
  2. Create a cron job to run that script every day/hour/minute.
    3. -
  3. Configure raadfiles::custom_setup (TBD, see R/zzz.R for the in-built mechanism)
    4. -
-
-
-

-Why raadfiles for raadtools?

-
    -
  • consistent convention around “file”, “root” in the file cache to have a clear separation on the configured path versus the data
    • -
  • mechanism to load file cache into memory on load, for all functions to share
    • -
  • -
    • -
-
library(raadtools)
-system.time(rt_files <- sstfiles())
-
-library(raadfiles)
-system.time(rf_files <- oisst_daily_files())
-
-range(rt_files$date)
-range(rf_files$date)
-
-length(rt_files$date)
-length(rf_files$date)
-
-
-
- - - -
- - -
-

Developed by Michael D. Sumner.

-
- -
-

Site built with pkgdown 1.3.0.

-
-
-
- - - - - diff --git a/docs/link.svg b/docs/link.svg deleted file mode 100644 index 88ad827..0000000 --- a/docs/link.svg +++ /dev/null @@ -1,12 +0,0 @@ - - - - - - diff --git a/docs/news/index.html b/docs/news/index.html deleted file mode 100644 index 88a2069..0000000 --- a/docs/news/index.html +++ /dev/null @@ -1,149 +0,0 @@ - - - - - - - - -Changelog • raadfiles - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-
- - - -
- -
-
-
-

Changelog

- -
- -
-

-raadfiles 0.1.2

-
    -

  • New GEBCO 2019 function gebco19_files().

    • -

  • New function srtm_files.

    • -

  • New function for SMAP salinity files.

    • -

  • New function for fsle files().

    • -
-
-
-

-raadfiles 0.0.1

-
    -

  • standard cache now separates “root” and “file” as separate columns

    • -

  • general scheme for file cache that can incorporate other collections

    • -

  • separated out from raadtools

    • -
-
-
- - - -
- -
-
-

Developed by Michael D. Sumner.

-
- -
-

Site built with pkgdown 1.3.0.

-
-
-
- - - - - - diff --git a/docs/pkgdown.css b/docs/pkgdown.css deleted file mode 100644 index c03fb08..0000000 --- a/docs/pkgdown.css +++ /dev/null @@ -1,236 +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 > .container { - display: flex; - height: 100%; - flex-direction: column; - - padding-top: 60px; -} - -body > .container .row { - flex: 1 0 auto; -} - -footer { - margin-top: 45px; - padding: 35px 0 36px; - border-top: 1px solid #e5e5e5; - color: #666; - display: flex; - flex-shrink: 0; -} -footer p { - margin-bottom: 0; -} -footer div { - flex: 1; -} -footer .pkgdown { - text-align: right; -} -footer p { - margin-bottom: 0; -} - -img.icon { - float: right; -} - -img { - max-width: 100%; -} - -/* Fix bug in bootstrap (only seen in firefox) */ -summary { - display: list-item; -} - -/* Typographic tweaking ---------------------------------*/ - -.contents .page-header { - margin-top: calc(-60px + 1em); -} - -/* Section anchors ---------------------------------*/ - -a.anchor { - margin-left: -30px; - display:inline-block; - width: 30px; - height: 30px; - visibility: hidden; - - background-image: url(./link.svg); - background-repeat: no-repeat; - background-size: 20px 20px; - background-position: center center; -} - -.hasAnchor:hover a.anchor { - visibility: visible; -} - -@media (max-width: 767px) { - .hasAnchor:hover a.anchor { - visibility: hidden; - } -} - - -/* Fixes for fixed navbar --------------------------*/ - -.contents h1, .contents h2, .contents h3, .contents h4 { - padding-top: 60px; - margin-top: -40px; -} - -/* Static header placement on mobile devices */ -@media (max-width: 767px) { - .navbar-fixed-top { - position: absolute; - } - .navbar { - padding: 0; - } -} - - -/* Sidebar --------------------------*/ - -#sidebar { - margin-top: 30px; -} -#sidebar h2 { - font-size: 1.5em; - margin-top: 1em; -} - -#sidebar h2:first-child { - margin-top: 0; -} - -#sidebar .list-unstyled li { - margin-bottom: 0.5em; -} - -.orcid { - height: 16px; - vertical-align: middle; -} - -/* Reference index & topics ----------------------------------------------- */ - -.ref-index th {font-weight: normal;} - -.ref-index td {vertical-align: top;} -.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;} -.ref-arguments .name {width: 20%;} -.ref-arguments .desc {width: 80%;} - -/* Nice scrolling for wide elements --------------------------------------- */ - -table { - display: block; - overflow: auto; -} - -/* Syntax highlighting ---------------------------------------------------- */ - -pre { - word-wrap: normal; - word-break: normal; - border: 1px solid #eee; -} - -pre, code { - background-color: #f8f8f8; - color: #333; -} - -pre code { - overflow: auto; - word-wrap: normal; - white-space: pre; -} - -pre .img { - margin: 5px 0; -} - -pre .img img { - background-color: #fff; - display: block; - height: auto; -} - -code a, pre a { - color: #375f84; -} - -a.sourceLine:hover { - text-decoration: none; -} - -.fl {color: #1514b5;} -.fu {color: #000000;} /* function */ -.ch,.st {color: #036a07;} /* string */ -.kw {color: #264D66;} /* keyword */ -.co {color: #888888;} /* comment */ - -.message { color: black; font-weight: bolder;} -.error { color: orange; font-weight: bolder;} -.warning { color: #6A0366; font-weight: bolder;} - -/* Clipboard --------------------------*/ - -.hasCopyButton { - position: relative; -} - -.btn-copy-ex { - position: absolute; - right: 0; - top: 0; - visibility: hidden; -} - -.hasCopyButton:hover button.btn-copy-ex { - visibility: visible; -} - -/* 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; -} diff --git a/docs/pkgdown.js b/docs/pkgdown.js deleted file mode 100644 index eb7e83d..0000000 --- a/docs/pkgdown.js +++ /dev/null @@ -1,115 +0,0 @@ -/* http://gregfranko.com/blog/jquery-best-practices/ */ -(function($) { - $(function() { - - $("#sidebar") - .stick_in_parent({offset_top: 40}) - .on('sticky_kit:bottom', function(e) { - $(this).parent().css('position', 'static'); - }) - .on('sticky_kit:unbottom', function(e) { - $(this).parent().css('position', 'relative'); - }); - - $('body').scrollspy({ - target: '#sidebar', - offset: 60 - }); - - $('[data-toggle="tooltip"]').tooltip(); - - var cur_path = paths(location.pathname); - var links = $("#navbar ul li a"); - var max_length = -1; - var pos = -1; - for (var i = 0; i < links.length; i++) { - if (links[i].getAttribute("href") === "#") - continue; - // Ignore external links - if (links[i].host !== location.host) - continue; - - var nav_path = paths(links[i].pathname); - - var length = prefix_length(nav_path, cur_path); - if (length > max_length) { - max_length = length; - pos = i; - } - } - - // Add class to parent
  • , and enclosing
  • if in dropdown - if (pos >= 0) { - var menu_anchor = $(links[pos]); - menu_anchor.parent().addClass("active"); - menu_anchor.closest("li.dropdown").addClass("active"); - } - }); - - function paths(pathname) { - var pieces = pathname.split("/"); - pieces.shift(); // always starts with / - - var end = pieces[pieces.length - 1]; - if (end === "index.html" || end === "") - pieces.pop(); - return(pieces); - } - - // Returns -1 if not found - function prefix_length(needle, haystack) { - if (needle.length > haystack.length) - return(-1); - - // Special case for length-0 haystack, since for loop won't run - if (haystack.length === 0) { - return(needle.length === 0 ? 0 : -1); - } - - for (var i = 0; i < haystack.length; i++) { - if (needle[i] != haystack[i]) - return(i); - } - - return(haystack.length); - } - - /* Clipboard --------------------------*/ - - function changeTooltipMessage(element, msg) { - var tooltipOriginalTitle=element.getAttribute('data-original-title'); - element.setAttribute('data-original-title', msg); - $(element).tooltip('show'); - element.setAttribute('data-original-title', tooltipOriginalTitle); - } - - if(ClipboardJS.isSupported()) { - $(document).ready(function() { - var copyButton = ""; - - $(".examples, div.sourceCode").addClass("hasCopyButton"); - - // Insert copy buttons: - $(copyButton).prependTo(".hasCopyButton"); - - // Initialize tooltips: - $('.btn-copy-ex').tooltip({container: 'body'}); - - // Initialize clipboard: - var clipboardBtnCopies = new ClipboardJS('[data-clipboard-copy]', { - text: function(trigger) { - return trigger.parentNode.textContent; - } - }); - - clipboardBtnCopies.on('success', function(e) { - changeTooltipMessage(e.trigger, 'Copied!'); - e.clearSelection(); - }); - - clipboardBtnCopies.on('error', function() { - changeTooltipMessage(e.trigger,'Press Ctrl+C or Command+C to copy'); - }); - }); - } -})(window.jQuery || window.$) diff --git a/docs/pkgdown.yml b/docs/pkgdown.yml deleted file mode 100644 index 254fe91..0000000 --- a/docs/pkgdown.yml +++ /dev/null @@ -1,5 +0,0 @@ -pandoc: 2.3.1 -pkgdown: 1.3.0 -pkgdown_sha: ~ -articles: [] - diff --git a/docs/reference/altimetry.html b/docs/reference/altimetry.html deleted file mode 100644 index 44b99ba..0000000 --- a/docs/reference/altimetry.html +++ /dev/null @@ -1,191 +0,0 @@ - - - - - - - - -Altimetry products — altimetry • raadfiles - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    -
    - - - -
    - -
    -
    -
    -

    Altimetry products

    - - -
    - -
    - -

    Sea Surface Height measured by Altimetry and derived variables. SSALTO/DUACS Near-Real-Time Level-4 -sea surface height and derived variables measured by multi-satellite altimetry observations over -Global Ocean.

    -

    WOA09 incomplete function

    - -
    - - 
    altimetry_daily_files()
-
-woa09_daily_files()
    - -

    Value

    - -

    tibble data frame of file names

    -

    tibble data frame of file names

    - -

    Details

    - -

    In 2018/2019 the file servers migrated to 'my.cmems-du.au' and 'nrt.cmems-du.eu' from 'ftp.sltac.cls.fr', but -the files and file name scheme remained unchanged so no net effect (so far that we are aware of).

    -

    Current returns all NetCDF files, without any date.

    - - -

    Examples

    - 
    altimetry_daily_files()
    #> # A tibble: 9,638 x 3
-#>    date                fullname                                root             
-#>    <dttm>              <chr>                                   <chr>            
-#>  1 1993-01-01 00:00:00 /rdsi/PRIVATE/raad/data_deprecated/ftp… /rdsi/PRIVATE/ra…
-#>  2 1993-01-02 00:00:00 /rdsi/PRIVATE/raad/data_deprecated/ftp… /rdsi/PRIVATE/ra…
-#>  3 1993-01-03 00:00:00 /rdsi/PRIVATE/raad/data_deprecated/ftp… /rdsi/PRIVATE/ra…
-#>  4 1993-01-04 00:00:00 /rdsi/PRIVATE/raad/data_deprecated/ftp… /rdsi/PRIVATE/ra…
-#>  5 1993-01-05 00:00:00 /rdsi/PRIVATE/raad/data_deprecated/ftp… /rdsi/PRIVATE/ra…
-#>  6 1993-01-06 00:00:00 /rdsi/PRIVATE/raad/data_deprecated/ftp… /rdsi/PRIVATE/ra…
-#>  7 1993-01-07 00:00:00 /rdsi/PRIVATE/raad/data_deprecated/ftp… /rdsi/PRIVATE/ra…
-#>  8 1993-01-08 00:00:00 /rdsi/PRIVATE/raad/data_deprecated/ftp… /rdsi/PRIVATE/ra…
-#>  9 1993-01-09 00:00:00 /rdsi/PRIVATE/raad/data_deprecated/ftp… /rdsi/PRIVATE/ra…
-#> 10 1993-01-10 00:00:00 /rdsi/PRIVATE/raad/data_deprecated/ftp… /rdsi/PRIVATE/ra…
-#> # … with 9,628 more rows
    woa09_daily_files()
    #> # A tibble: 765 x 2
-#>    fullname                                               root                  
-#>    <chr>                                                  <chr>                 
-#>  1 /rdsi/PRIVATE/raad/data_staging/data.nodc.noaa.gov/th… /rdsi/PRIVATE/raad/da…
-#>  2 /rdsi/PUBLIC/raad/data/data.nodc.noaa.gov/woa/WOA09/N… /rdsi/PUBLIC/raad/data
-#>  3 /rdsi/PUBLIC/raad/data/data.nodc.noaa.gov/woa/WOA09/N… /rdsi/PUBLIC/raad/data
-#>  4 /rdsi/PUBLIC/raad/data/data.nodc.noaa.gov/woa/WOA09/N… /rdsi/PUBLIC/raad/data
-#>  5 /rdsi/PUBLIC/raad/data/data.nodc.noaa.gov/woa/WOA09/N… /rdsi/PUBLIC/raad/data
-#>  6 /rdsi/PUBLIC/raad/data/data.nodc.noaa.gov/woa/WOA09/N… /rdsi/PUBLIC/raad/data
-#>  7 /rdsi/PUBLIC/raad/data/data.nodc.noaa.gov/woa/WOA09/N… /rdsi/PUBLIC/raad/data
-#>  8 /rdsi/PUBLIC/raad/data/data.nodc.noaa.gov/woa/WOA09/N… /rdsi/PUBLIC/raad/data
-#>  9 /rdsi/PUBLIC/raad/data/data.nodc.noaa.gov/woa/WOA09/N… /rdsi/PUBLIC/raad/data
-#> 10 /rdsi/PUBLIC/raad/data/data.nodc.noaa.gov/woa/WOA09/N… /rdsi/PUBLIC/raad/data
-#> # … with 755 more rows
    -
    - -
    - -
    -
    -

    Developed by Michael D. Sumner.

    -
    - -
    -

    Site built with pkgdown 1.3.0.

    -
    -
    -
    - - - - - - diff --git a/docs/reference/amps_files.html b/docs/reference/amps_files.html deleted file mode 100644 index 5f11dca..0000000 --- a/docs/reference/amps_files.html +++ /dev/null @@ -1,224 +0,0 @@ - - - - - - - - -AMPS files — amps_files • raadfiles - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    -
    - - - -
    - -
    -
    -
    -

    AMPS files

    - - -
    - -
    - -

    Antarctic Mesoscale Prediction System GRIB files.

    - -
    - - 
    amps_files()
-
-amps_model_files(time.resolution = "4hourly", grid = "d1", ...)
-
-amps_d1files(time.resolution = "4hourly", ...)
-
-amps_d2files(time.resolution = "4hourly", ...)
    - -

    Arguments

    - - - - - - - - - - - - - - -
    time.resolution

    a placeholder, defaults to "4hourly" and remains unused

    grid

    one of `d1` (30km resolution) or `d2` (10km resolution)

    ...

    reserved, unused

    - -

    Details

    - -

    `amps_files` returns all the files, `amps_model_files` returns the files with date set from the file name, `amps_d1files` and `amps_d2files` return only the 30km and 10 km resolution grids respectively.

    - - -

    Examples

    - 
    amps_files()
    #> # A tibble: 42,256 x 2
-#>    root                file                                                     
-#>    <chr>               <chr>                                                    
-#>  1 /rdsi/PUBLIC/raad/… www2.mmm.ucar.edu/rt/amps/wrf_grib/20151025/2015102512_W…
-#>  2 /rdsi/PUBLIC/raad/… www2.mmm.ucar.edu/rt/amps/wrf_grib/20151025/2015102512_W…
-#>  3 /rdsi/PUBLIC/raad/… www2.mmm.ucar.edu/rt/amps/wrf_grib/20151025/2015102512_W…
-#>  4 /rdsi/PUBLIC/raad/… www2.mmm.ucar.edu/rt/amps/wrf_grib/20151025/2015102512_W…
-#>  5 /rdsi/PUBLIC/raad/… www2.mmm.ucar.edu/rt/amps/wrf_grib/20151025/2015102512_W…
-#>  6 /rdsi/PUBLIC/raad/… www2.mmm.ucar.edu/rt/amps/wrf_grib/20151025/2015102512_W…
-#>  7 /rdsi/PUBLIC/raad/… www2.mmm.ucar.edu/rt/amps/wrf_grib/20151025/2015102512_W…
-#>  8 /rdsi/PUBLIC/raad/… www2.mmm.ucar.edu/rt/amps/wrf_grib/20151025/2015102512_W…
-#>  9 /rdsi/PUBLIC/raad/… www2.mmm.ucar.edu/rt/amps/wrf_grib/20151025/2015102512_W…
-#> 10 /rdsi/PUBLIC/raad/… www2.mmm.ucar.edu/rt/amps/wrf_grib/20151025/2015102512_W…
-#> # … with 42,246 more rows
    amps_model_files()
    #> # A tibble: 21,137 x 5
-#>    hour  model date                fullname                          root       
-#>    <chr> <chr> <dttm>              <chr>                             <chr>      
-#>  1 000   12    2015-10-25 12:00:00 /rdsi/PUBLIC/raad/data/www2.mmm.… /rdsi/PUBL…
-#>  2 003   12    2015-10-25 15:00:00 /rdsi/PUBLIC/raad/data/www2.mmm.… /rdsi/PUBL…
-#>  3 006   12    2015-10-25 18:00:00 /rdsi/PUBLIC/raad/data/www2.mmm.… /rdsi/PUBL…
-#>  4 009   12    2015-10-25 21:00:00 /rdsi/PUBLIC/raad/data/www2.mmm.… /rdsi/PUBL…
-#>  5 012   12    2015-10-26 00:00:00 /rdsi/PUBLIC/raad/data/www2.mmm.… /rdsi/PUBL…
-#>  6 015   12    2015-10-26 03:00:00 /rdsi/PUBLIC/raad/data/www2.mmm.… /rdsi/PUBL…
-#>  7 000   00    2015-10-26 00:00:00 /rdsi/PUBLIC/raad/data/www2.mmm.… /rdsi/PUBL…
-#>  8 003   00    2015-10-26 03:00:00 /rdsi/PUBLIC/raad/data/www2.mmm.… /rdsi/PUBL…
-#>  9 006   00    2015-10-26 06:00:00 /rdsi/PUBLIC/raad/data/www2.mmm.… /rdsi/PUBL…
-#> 10 009   00    2015-10-26 09:00:00 /rdsi/PUBLIC/raad/data/www2.mmm.… /rdsi/PUBL…
-#> # … with 21,127 more rows
    amps_d1files()
    #> # A tibble: 9,582 x 3
-#>    date                fullname                                    root         
-#>    <dttm>              <chr>                                       <chr>        
-#>  1 2015-10-25 12:00:00 /rdsi/PUBLIC/raad/data/www2.mmm.ucar.edu/r… /rdsi/PUBLIC…
-#>  2 2015-10-25 15:00:00 /rdsi/PUBLIC/raad/data/www2.mmm.ucar.edu/r… /rdsi/PUBLIC…
-#>  3 2015-10-25 18:00:00 /rdsi/PUBLIC/raad/data/www2.mmm.ucar.edu/r… /rdsi/PUBLIC…
-#>  4 2015-10-25 21:00:00 /rdsi/PUBLIC/raad/data/www2.mmm.ucar.edu/r… /rdsi/PUBLIC…
-#>  5 2015-10-26 00:00:00 /rdsi/PUBLIC/raad/data/www2.mmm.ucar.edu/r… /rdsi/PUBLIC…
-#>  6 2015-10-26 03:00:00 /rdsi/PUBLIC/raad/data/www2.mmm.ucar.edu/r… /rdsi/PUBLIC…
-#>  7 2015-10-26 06:00:00 /rdsi/PUBLIC/raad/data/www2.mmm.ucar.edu/r… /rdsi/PUBLIC…
-#>  8 2015-10-26 09:00:00 /rdsi/PUBLIC/raad/data/www2.mmm.ucar.edu/r… /rdsi/PUBLIC…
-#>  9 2015-10-26 12:00:00 /rdsi/PUBLIC/raad/data/www2.mmm.ucar.edu/r… /rdsi/PUBLIC…
-#> 10 2015-10-26 15:00:00 /rdsi/PUBLIC/raad/data/www2.mmm.ucar.edu/r… /rdsi/PUBLIC…
-#> # … with 9,572 more rows
    amps_d2files()
    #> # A tibble: 9,547 x 3
-#>    date                fullname                                    root         
-#>    <dttm>              <chr>                                       <chr>        
-#>  1 2015-10-25 12:00:00 /rdsi/PUBLIC/raad/data/www2.mmm.ucar.edu/r… /rdsi/PUBLIC…
-#>  2 2015-10-25 15:00:00 /rdsi/PUBLIC/raad/data/www2.mmm.ucar.edu/r… /rdsi/PUBLIC…
-#>  3 2015-10-25 18:00:00 /rdsi/PUBLIC/raad/data/www2.mmm.ucar.edu/r… /rdsi/PUBLIC…
-#>  4 2015-10-25 21:00:00 /rdsi/PUBLIC/raad/data/www2.mmm.ucar.edu/r… /rdsi/PUBLIC…
-#>  5 2015-10-26 00:00:00 /rdsi/PUBLIC/raad/data/www2.mmm.ucar.edu/r… /rdsi/PUBLIC…
-#>  6 2015-10-26 03:00:00 /rdsi/PUBLIC/raad/data/www2.mmm.ucar.edu/r… /rdsi/PUBLIC…
-#>  7 2015-10-26 06:00:00 /rdsi/PUBLIC/raad/data/www2.mmm.ucar.edu/r… /rdsi/PUBLIC…
-#>  8 2015-10-26 09:00:00 /rdsi/PUBLIC/raad/data/www2.mmm.ucar.edu/r… /rdsi/PUBLIC…
-#>  9 2015-10-26 12:00:00 /rdsi/PUBLIC/raad/data/www2.mmm.ucar.edu/r… /rdsi/PUBLIC…
-#> 10 2015-10-26 15:00:00 /rdsi/PUBLIC/raad/data/www2.mmm.ucar.edu/r… /rdsi/PUBLIC…
-#> # … with 9,537 more rows
    -
    - -
    - -
    -
    -

    Developed by Michael D. Sumner.

    -
    - -
    -

    Site built with pkgdown 1.3.0.

    -
    -
    -
    - - - - - - diff --git a/docs/reference/argo_files.html b/docs/reference/argo_files.html deleted file mode 100644 index 9eae033..0000000 --- a/docs/reference/argo_files.html +++ /dev/null @@ -1,159 +0,0 @@ - - - - - - - - -Argo files. — argo_files • raadfiles - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    -
    - - - -
    - -
    -
    -
    -

    Argo files.

    - - -
    - -
    - -

    ARGO

    - -
    - - 
    argo_files(type = c("prof", "meta", "traj", "tech", "Mprof"),
-  dac = NULL)
    - -

    Arguments

    - - - - - - - - - - -
    type

    file type, i.e. prof, meta, traj, tech

    dac

    data acqusition centre e.g.* "aoml", "bodc", "coriolis", "csio", "csiro", "incois", all returned if not specified

    - -

    References

    - -

    [https://www.aviso.altimetry.fr/en/data/products/value-added-products/fsle-finite-size-lyapunov-exponents.html]( Finite-Size Lyapunov Exponents)

    - - -
    - -
    - -
    -
    -

    Developed by Michael D. Sumner.

    -
    - -
    -

    Site built with pkgdown 1.3.0.

    -
    -
    -
    - - - - - - diff --git a/docs/reference/bom_tmax_daily_files.html b/docs/reference/bom_tmax_daily_files.html deleted file mode 100644 index a665e69..0000000 --- a/docs/reference/bom_tmax_daily_files.html +++ /dev/null @@ -1,144 +0,0 @@ - - - - - - - - -BOM tmax daily fils — bom_tmax_daily_files • raadfiles - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    -
    - - - -
    - -
    -
    -
    -

    BOM tmax daily fils

    - - -
    - -
    - -

    Data is daily but arranged in monthly files.

    - -
    - - 
    bom_tmax_daily_files()
    - -

    Value

    - -

    data frame of file names

    - - -
    - -
    - -
    -
    -

    Developed by Michael D. Sumner.

    -
    - -
    -

    Site built with pkgdown 1.3.0.

    -
    -
    -
    - - - - - - diff --git a/docs/reference/cmip5_files.html b/docs/reference/cmip5_files.html deleted file mode 100644 index 4429abf..0000000 --- a/docs/reference/cmip5_files.html +++ /dev/null @@ -1,144 +0,0 @@ - - - - - - - - -CMIP5 files — cmip5_files • raadfiles - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    -
    - - - -
    - -
    -
    -
    -

    CMIP5 files

    - - -
    - -
    - -

    Currently in dev-test mode, using a very small subset until we get specifications.

    - -
    - - 
    cmip5_files()
    - -

    Value

    - -

    data frame of file names

    - - -
    - -
    - -
    -
    -

    Developed by Michael D. Sumner.

    -
    - -
    -

    Site built with pkgdown 1.3.0.

    -
    -
    -
    - - - - - - diff --git a/docs/reference/fsle_files.html b/docs/reference/fsle_files.html deleted file mode 100644 index d422c3d..0000000 --- a/docs/reference/fsle_files.html +++ /dev/null @@ -1,150 +0,0 @@ - - - - - - - - -Backward-in-time Finite-Size Lyapunov Exponents. — fsle_files • raadfiles - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    -
    - - - -
    - -
    -
    -
    -

    Backward-in-time Finite-Size Lyapunov Exponents.

    - - -
    - -
    - -

    FSLE - MAPS OF FINITE SIZE LYAPUNOV EXPONENTS AND ORIENTATIONS OF THE ASSOCIATED EIGENVECTORS

    - -
    - - 
    fsle_files()
    - -

    Details

    - -

    These are daily files.

    - -

    References

    - -

    [https://www.aviso.altimetry.fr/en/data/products/value-added-products/fsle-finite-size-lyapunov-exponents.html]( Finite-Size Lyapunov Exponents)

    - - -
    - -
    - -
    -
    -

    Developed by Michael D. Sumner.

    -
    - -
    -

    Site built with pkgdown 1.3.0.

    -
    -
    -
    - - - - - - diff --git a/docs/reference/ghrsst.html b/docs/reference/ghrsst.html deleted file mode 100644 index 3bb8773..0000000 --- a/docs/reference/ghrsst.html +++ /dev/null @@ -1,161 +0,0 @@ - - - - - - - - -GHRSST files — ghrsst • raadfiles - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    -
    - - - -
    - -
    -
    -
    -

    GHRSST files

    - - -
    - -
    - -

    The Group for High Resolution Sea Surface Temperature (GHRSST) files.

    - -
    - - 
    ghrsst_daily_files()
    - -

    Value

    - -

    tibble data frame of file names

    - - -

    Examples

    - 
    oisst_daily_files()
    #> # A tibble: 13,777 x 3
-#>    date                fullname                                    root         
-#>    <dttm>              <chr>                                       <chr>        
-#>  1 1981-09-01 00:00:00 /rdsi/PUBLIC/raad/data/www.ncei.noaa.gov/d… /rdsi/PUBLIC…
-#>  2 1981-09-02 00:00:00 /rdsi/PUBLIC/raad/data/www.ncei.noaa.gov/d… /rdsi/PUBLIC…
-#>  3 1981-09-03 00:00:00 /rdsi/PUBLIC/raad/data/www.ncei.noaa.gov/d… /rdsi/PUBLIC…
-#>  4 1981-09-04 00:00:00 /rdsi/PUBLIC/raad/data/www.ncei.noaa.gov/d… /rdsi/PUBLIC…
-#>  5 1981-09-05 00:00:00 /rdsi/PUBLIC/raad/data/www.ncei.noaa.gov/d… /rdsi/PUBLIC…
-#>  6 1981-09-06 00:00:00 /rdsi/PUBLIC/raad/data/www.ncei.noaa.gov/d… /rdsi/PUBLIC…
-#>  7 1981-09-07 00:00:00 /rdsi/PUBLIC/raad/data/www.ncei.noaa.gov/d… /rdsi/PUBLIC…
-#>  8 1981-09-08 00:00:00 /rdsi/PUBLIC/raad/data/www.ncei.noaa.gov/d… /rdsi/PUBLIC…
-#>  9 1981-09-09 00:00:00 /rdsi/PUBLIC/raad/data/www.ncei.noaa.gov/d… /rdsi/PUBLIC…
-#> 10 1981-09-10 00:00:00 /rdsi/PUBLIC/raad/data/www.ncei.noaa.gov/d… /rdsi/PUBLIC…
-#> # … with 13,767 more rows
    -
    - -
    - -
    -
    -

    Developed by Michael D. Sumner.

    -
    - -
    -

    Site built with pkgdown 1.3.0.

    -
    -
    -
    - - - - - - diff --git a/docs/reference/index.html b/docs/reference/index.html deleted file mode 100644 index 924957e..0000000 --- a/docs/reference/index.html +++ /dev/null @@ -1,239 +0,0 @@ - - - - - - - - -Function reference • raadfiles - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    -
    - - - -
    - -
    -
    -
    -

    Reference

    -
    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    -

    All functions

    -

    -
    -

    altimetry_daily_files() woa09_daily_files()

    -

    Altimetry products

    -

    amps_files() amps_model_files() amps_d1files() amps_d2files()

    -

    AMPS files

    -

    argo_files()

    -

    Argo files.

    -

    bom_tmax_daily_files()

    -

    BOM tmax daily fils

    -

    cmip5_files()

    -

    CMIP5 files

    -

    fsle_files()

    -

    Backward-in-time Finite-Size Lyapunov Exponents.

    -

    ghrsst_daily_files()

    -

    GHRSST files

    -

    ncep2_uwnd_6hr_files() ncep2_vwnd_6hr_files()

    -

    NCEP2 wind files

    -

    nsidc_south_monthly_files() nsidc_north_monthly_files() nsidc_monthly_files() nsidc_south_daily_files() nsidc_north_daily_files() nsidc_daily_files()

    -

    NSIDC daily and monthly sea-ice concentration

    -

    amsr_daily_files() oisst_daily_files() oisst_monthly_files()

    -

    AMSR daily sea-ice concentration

    -

    get_raad_data_roots() get_raad_filenames() set_raad_data_roots() raad_filedb_path() set_raad_filenames() run_build_raad_cache()

    -

    Raadfiles administration tools

    -

    rema_tile_files() rema_100m_files() rema_200m_files() rema_1km_files() rema_8m_files()

    -

    Files for The Reference Elevation Model of Antarctica (REMA)

    -

    smap_8day_files()

    -

    SMAP ocean surface salinity files

    -

    srtm_files()

    -

    SRTM files

    -

    thelist_files()

    -

    TheList

    -

    gebco19_files() gebco08_files() ramp_files() ibcso_files() ibcso_background_files() ibcso_bed_files() ibcso_digital_chart_files() ibcso_sid_files() cryosat2_files() etopo1_files() etopo2_files() lakesuperior_files() kerguelen_files() george_v_terre_adelie_1000m_files() george_v_terre_adelie_500m_files() george_v_terre_adelie_250m_files() george_v_terre_adelie_100m_files() smith_sandwell_files() smith_sandwell_unpolished_files() smith_sandwell_lon180_files() smith_sandwell_unpolished_lon180_files() macquarie100m_57S_files() macquarie100m_58S_files()

    -

    Topographic data files

    -
    - - -
    - -
    -
    -

    Developed by Michael D. Sumner.

    -
    - -
    -

    Site built with pkgdown 1.3.0.

    -
    -
    -
    - - - - - - diff --git a/docs/reference/ncep2_files.html b/docs/reference/ncep2_files.html deleted file mode 100644 index 4cdc72b..0000000 --- a/docs/reference/ncep2_files.html +++ /dev/null @@ -1,176 +0,0 @@ - - - - - - - - -NCEP2 wind files — ncep2_files • raadfiles - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    -
    - - - -
    - -
    -
    -
    -

    NCEP2 wind files

    - - -
    - -
    - -

    NCEP2 six-hourly reanalysis2 gaussian grid

    - -
    - - 
    ncep2_uwnd_6hr_files()
-
-ncep2_vwnd_6hr_files()
    - -

    Value

    - -

    tibble data frame of file names

    - - -

    Examples

    - 
    ncep2_uwnd_6hr_files()
    #> # A tibble: 41 x 3
-#>    date                fullname                                    root         
-#>    <dttm>              <chr>                                       <chr>        
-#>  1 1979-01-01 12:00:00 /rdsi/PUBLIC/raad/data/ftp.cdc.noaa.gov/Da… /rdsi/PUBLIC…
-#>  2 1980-01-01 12:00:00 /rdsi/PUBLIC/raad/data/ftp.cdc.noaa.gov/Da… /rdsi/PUBLIC…
-#>  3 1981-01-01 12:00:00 /rdsi/PUBLIC/raad/data/ftp.cdc.noaa.gov/Da… /rdsi/PUBLIC…
-#>  4 1982-01-01 12:00:00 /rdsi/PUBLIC/raad/data/ftp.cdc.noaa.gov/Da… /rdsi/PUBLIC…
-#>  5 1983-01-01 12:00:00 /rdsi/PUBLIC/raad/data/ftp.cdc.noaa.gov/Da… /rdsi/PUBLIC…
-#>  6 1984-01-01 12:00:00 /rdsi/PUBLIC/raad/data/ftp.cdc.noaa.gov/Da… /rdsi/PUBLIC…
-#>  7 1985-01-01 12:00:00 /rdsi/PUBLIC/raad/data/ftp.cdc.noaa.gov/Da… /rdsi/PUBLIC…
-#>  8 1986-01-01 12:00:00 /rdsi/PUBLIC/raad/data/ftp.cdc.noaa.gov/Da… /rdsi/PUBLIC…
-#>  9 1987-01-01 12:00:00 /rdsi/PUBLIC/raad/data/ftp.cdc.noaa.gov/Da… /rdsi/PUBLIC…
-#> 10 1988-01-01 12:00:00 /rdsi/PUBLIC/raad/data/ftp.cdc.noaa.gov/Da… /rdsi/PUBLIC…
-#> # … with 31 more rows
    ncep2_vwnd_6hr_files()
    #> # A tibble: 41 x 3
-#>    date                fullname                                    root         
-#>    <dttm>              <chr>                                       <chr>        
-#>  1 1979-01-01 12:00:00 /rdsi/PUBLIC/raad/data/ftp.cdc.noaa.gov/Da… /rdsi/PUBLIC…
-#>  2 1980-01-01 12:00:00 /rdsi/PUBLIC/raad/data/ftp.cdc.noaa.gov/Da… /rdsi/PUBLIC…
-#>  3 1981-01-01 12:00:00 /rdsi/PUBLIC/raad/data/ftp.cdc.noaa.gov/Da… /rdsi/PUBLIC…
-#>  4 1982-01-01 12:00:00 /rdsi/PUBLIC/raad/data/ftp.cdc.noaa.gov/Da… /rdsi/PUBLIC…
-#>  5 1983-01-01 12:00:00 /rdsi/PUBLIC/raad/data/ftp.cdc.noaa.gov/Da… /rdsi/PUBLIC…
-#>  6 1984-01-01 12:00:00 /rdsi/PUBLIC/raad/data/ftp.cdc.noaa.gov/Da… /rdsi/PUBLIC…
-#>  7 1985-01-01 12:00:00 /rdsi/PUBLIC/raad/data/ftp.cdc.noaa.gov/Da… /rdsi/PUBLIC…
-#>  8 1986-01-01 12:00:00 /rdsi/PUBLIC/raad/data/ftp.cdc.noaa.gov/Da… /rdsi/PUBLIC…
-#>  9 1987-01-01 12:00:00 /rdsi/PUBLIC/raad/data/ftp.cdc.noaa.gov/Da… /rdsi/PUBLIC…
-#> 10 1988-01-01 12:00:00 /rdsi/PUBLIC/raad/data/ftp.cdc.noaa.gov/Da… /rdsi/PUBLIC…
-#> # … with 31 more rows
    -
    - -
    - -
    -
    -

    Developed by Michael D. Sumner.

    -
    - -
    -

    Site built with pkgdown 1.3.0.

    -
    -
    -
    - - - - - - diff --git a/docs/reference/nsidc.html b/docs/reference/nsidc.html deleted file mode 100644 index 591adf1..0000000 --- a/docs/reference/nsidc.html +++ /dev/null @@ -1,236 +0,0 @@ - - - - - - - - -NSIDC daily and monthly sea-ice concentration — nsidc • raadfiles - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    -
    - - - -
    - -
    -
    -
    -

    NSIDC daily and monthly sea-ice concentration

    - - -
    - -
    - -

    Sea ice concentration files.

    - -
    - - 
    nsidc_south_monthly_files()
-
-nsidc_north_monthly_files()
-
-nsidc_monthly_files()
-
-nsidc_south_daily_files()
-
-nsidc_north_daily_files()
-
-nsidc_daily_files()
    - -

    Value

    - -

    tibble data frame of file names

    - - -

    Examples

    - 
    nsidc_south_monthly_files()
    #> # A tibble: 471 x 3
-#>    date                fullname                                    root         
-#>    <dttm>              <chr>                                       <chr>        
-#>  1 1978-10-01 00:00:00 /rdsi/PUBLIC/raad/data/sidads.colorado.edu… /rdsi/PUBLIC…
-#>  2 1978-11-01 00:00:00 /rdsi/PUBLIC/raad/data/sidads.colorado.edu… /rdsi/PUBLIC…
-#>  3 1978-12-01 00:00:00 /rdsi/PUBLIC/raad/data/sidads.colorado.edu… /rdsi/PUBLIC…
-#>  4 1979-01-01 00:00:00 /rdsi/PUBLIC/raad/data/sidads.colorado.edu… /rdsi/PUBLIC…
-#>  5 1979-02-01 00:00:00 /rdsi/PUBLIC/raad/data/sidads.colorado.edu… /rdsi/PUBLIC…
-#>  6 1979-03-01 00:00:00 /rdsi/PUBLIC/raad/data/sidads.colorado.edu… /rdsi/PUBLIC…
-#>  7 1979-04-01 00:00:00 /rdsi/PUBLIC/raad/data/sidads.colorado.edu… /rdsi/PUBLIC…
-#>  8 1979-05-01 00:00:00 /rdsi/PUBLIC/raad/data/sidads.colorado.edu… /rdsi/PUBLIC…
-#>  9 1979-06-01 00:00:00 /rdsi/PUBLIC/raad/data/sidads.colorado.edu… /rdsi/PUBLIC…
-#> 10 1979-07-01 00:00:00 /rdsi/PUBLIC/raad/data/sidads.colorado.edu… /rdsi/PUBLIC…
-#> # … with 461 more rows
    nsidc_north_monthly_files()
    #> # A tibble: 471 x 3
-#>    date                fullname                                    root         
-#>    <dttm>              <chr>                                       <chr>        
-#>  1 1978-10-01 00:00:00 /rdsi/PUBLIC/raad/data/sidads.colorado.edu… /rdsi/PUBLIC…
-#>  2 1978-11-01 00:00:00 /rdsi/PUBLIC/raad/data/sidads.colorado.edu… /rdsi/PUBLIC…
-#>  3 1978-12-01 00:00:00 /rdsi/PUBLIC/raad/data/sidads.colorado.edu… /rdsi/PUBLIC…
-#>  4 1979-01-01 00:00:00 /rdsi/PUBLIC/raad/data/sidads.colorado.edu… /rdsi/PUBLIC…
-#>  5 1979-02-01 00:00:00 /rdsi/PUBLIC/raad/data/sidads.colorado.edu… /rdsi/PUBLIC…
-#>  6 1979-03-01 00:00:00 /rdsi/PUBLIC/raad/data/sidads.colorado.edu… /rdsi/PUBLIC…
-#>  7 1979-04-01 00:00:00 /rdsi/PUBLIC/raad/data/sidads.colorado.edu… /rdsi/PUBLIC…
-#>  8 1979-05-01 00:00:00 /rdsi/PUBLIC/raad/data/sidads.colorado.edu… /rdsi/PUBLIC…
-#>  9 1979-06-01 00:00:00 /rdsi/PUBLIC/raad/data/sidads.colorado.edu… /rdsi/PUBLIC…
-#> 10 1979-07-01 00:00:00 /rdsi/PUBLIC/raad/data/sidads.colorado.edu… /rdsi/PUBLIC…
-#> # … with 461 more rows
    nsidc_monthly_files()
    #> # A tibble: 1,844 x 3
-#>    date                fullname                                    root         
-#>    <dttm>              <chr>                                       <chr>        
-#>  1 1978-10-01 00:00:00 /rdsi/PUBLIC/raad/data/sidads.colorado.edu… /rdsi/PUBLIC…
-#>  2 1978-11-01 00:00:00 /rdsi/PUBLIC/raad/data/sidads.colorado.edu… /rdsi/PUBLIC…
-#>  3 1978-11-01 00:00:00 /rdsi/PUBLIC/raad/data/sidads.colorado.edu… /rdsi/PUBLIC…
-#>  4 1978-12-01 00:00:00 /rdsi/PUBLIC/raad/data/sidads.colorado.edu… /rdsi/PUBLIC…
-#>  5 1978-12-01 00:00:00 /rdsi/PUBLIC/raad/data/sidads.colorado.edu… /rdsi/PUBLIC…
-#>  6 1979-01-01 00:00:00 /rdsi/PUBLIC/raad/data/sidads.colorado.edu… /rdsi/PUBLIC…
-#>  7 1979-01-01 00:00:00 /rdsi/PUBLIC/raad/data/sidads.colorado.edu… /rdsi/PUBLIC…
-#>  8 1979-02-01 00:00:00 /rdsi/PUBLIC/raad/data/sidads.colorado.edu… /rdsi/PUBLIC…
-#>  9 1979-02-01 00:00:00 /rdsi/PUBLIC/raad/data/sidads.colorado.edu… /rdsi/PUBLIC…
-#> 10 1979-03-01 00:00:00 /rdsi/PUBLIC/raad/data/sidads.colorado.edu… /rdsi/PUBLIC…
-#> # … with 1,834 more rows
    nsidc_south_daily_files()
    #> # A tibble: 13,167 x 3
-#>    date                fullname                                    root         
-#>    <dttm>              <chr>                                       <chr>        
-#>  1 1978-10-26 00:00:00 /rdsi/PUBLIC/raad/data/sidads.colorado.edu… /rdsi/PUBLIC…
-#>  2 1978-10-28 00:00:00 /rdsi/PUBLIC/raad/data/sidads.colorado.edu… /rdsi/PUBLIC…
-#>  3 1978-10-30 00:00:00 /rdsi/PUBLIC/raad/data/sidads.colorado.edu… /rdsi/PUBLIC…
-#>  4 1978-11-01 00:00:00 /rdsi/PUBLIC/raad/data/sidads.colorado.edu… /rdsi/PUBLIC…
-#>  5 1978-11-03 00:00:00 /rdsi/PUBLIC/raad/data/sidads.colorado.edu… /rdsi/PUBLIC…
-#>  6 1978-11-05 00:00:00 /rdsi/PUBLIC/raad/data/sidads.colorado.edu… /rdsi/PUBLIC…
-#>  7 1978-11-07 00:00:00 /rdsi/PUBLIC/raad/data/sidads.colorado.edu… /rdsi/PUBLIC…
-#>  8 1978-11-09 00:00:00 /rdsi/PUBLIC/raad/data/sidads.colorado.edu… /rdsi/PUBLIC…
-#>  9 1978-11-11 00:00:00 /rdsi/PUBLIC/raad/data/sidads.colorado.edu… /rdsi/PUBLIC…
-#> 10 1978-11-13 00:00:00 /rdsi/PUBLIC/raad/data/sidads.colorado.edu… /rdsi/PUBLIC…
-#> # … with 13,157 more rows
    nsidc_north_daily_files()
    #> # A tibble: 13,167 x 3
-#>    date                fullname                                    root         
-#>    <dttm>              <chr>                                       <chr>        
-#>  1 1978-10-26 00:00:00 /rdsi/PUBLIC/raad/data/sidads.colorado.edu… /rdsi/PUBLIC…
-#>  2 1978-10-28 00:00:00 /rdsi/PUBLIC/raad/data/sidads.colorado.edu… /rdsi/PUBLIC…
-#>  3 1978-10-30 00:00:00 /rdsi/PUBLIC/raad/data/sidads.colorado.edu… /rdsi/PUBLIC…
-#>  4 1978-11-01 00:00:00 /rdsi/PUBLIC/raad/data/sidads.colorado.edu… /rdsi/PUBLIC…
-#>  5 1978-11-03 00:00:00 /rdsi/PUBLIC/raad/data/sidads.colorado.edu… /rdsi/PUBLIC…
-#>  6 1978-11-05 00:00:00 /rdsi/PUBLIC/raad/data/sidads.colorado.edu… /rdsi/PUBLIC…
-#>  7 1978-11-07 00:00:00 /rdsi/PUBLIC/raad/data/sidads.colorado.edu… /rdsi/PUBLIC…
-#>  8 1978-11-09 00:00:00 /rdsi/PUBLIC/raad/data/sidads.colorado.edu… /rdsi/PUBLIC…
-#>  9 1978-11-11 00:00:00 /rdsi/PUBLIC/raad/data/sidads.colorado.edu… /rdsi/PUBLIC…
-#> 10 1978-11-13 00:00:00 /rdsi/PUBLIC/raad/data/sidads.colorado.edu… /rdsi/PUBLIC…
-#> # … with 13,157 more rows
    nsidc_daily_files()
    #> # A tibble: 28,042 x 3
-#>    date                fullname                                    root         
-#>    <dttm>              <chr>                                       <chr>        
-#>  1 1978-10-26 00:00:00 /rdsi/PUBLIC/raad/data/sidads.colorado.edu… /rdsi/PUBLIC…
-#>  2 1978-10-28 00:00:00 /rdsi/PUBLIC/raad/data/sidads.colorado.edu… /rdsi/PUBLIC…
-#>  3 1978-10-30 00:00:00 /rdsi/PUBLIC/raad/data/sidads.colorado.edu… /rdsi/PUBLIC…
-#>  4 1978-11-01 00:00:00 /rdsi/PUBLIC/raad/data/sidads.colorado.edu… /rdsi/PUBLIC…
-#>  5 1978-11-03 00:00:00 /rdsi/PUBLIC/raad/data/sidads.colorado.edu… /rdsi/PUBLIC…
-#>  6 1978-11-05 00:00:00 /rdsi/PUBLIC/raad/data/sidads.colorado.edu… /rdsi/PUBLIC…
-#>  7 1978-11-07 00:00:00 /rdsi/PUBLIC/raad/data/sidads.colorado.edu… /rdsi/PUBLIC…
-#>  8 1978-11-09 00:00:00 /rdsi/PUBLIC/raad/data/sidads.colorado.edu… /rdsi/PUBLIC…
-#>  9 1978-11-11 00:00:00 /rdsi/PUBLIC/raad/data/sidads.colorado.edu… /rdsi/PUBLIC…
-#> 10 1978-11-13 00:00:00 /rdsi/PUBLIC/raad/data/sidads.colorado.edu… /rdsi/PUBLIC…
-#> # … with 28,032 more rows
    -
    - -
    - -
    -
    -

    Developed by Michael D. Sumner.

    -
    - -
    -

    Site built with pkgdown 1.3.0.

    -
    -
    -
    - - - - - - diff --git a/docs/reference/oisst.html b/docs/reference/oisst.html deleted file mode 100644 index acfdee0..0000000 --- a/docs/reference/oisst.html +++ /dev/null @@ -1,199 +0,0 @@ - - - - - - - - -AMSR daily sea-ice concentration — oisst • raadfiles - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    -
    - - - -
    - -
    -
    -
    -

    AMSR daily sea-ice concentration

    - - -
    - -
    - -

    Sea ice concentration files at 6.25 km resolution, southern hemisphere.

    -

    Optimally Interpolated Sea Surface Temperature, from https://www.ncei.noaa.gov/. These files contain four -variables `sst`, `anom`, `err` and `ice` for sea surface temperature, sst anomaly, sst error and sea ice concentration on -a regular global longitude latitude grid, with dimensions 1440x720 grid (0.25 degree spatial resolution).

    - -
    - - 
    amsr_daily_files()
-
-oisst_daily_files()
-
-oisst_monthly_files()
    - -

    Value

    - -

    tibble data frame of file names

    -

    tibble data frame of file names, with columns `fullname` and `date`

    - -

    Details

    - -

    At the time of writing (2018-02-22) the files are accessible at -https://www.ncei.noaa.gov/data/sea-surface-temperature-optimum-interpolation/access/avhrr-only/. See the -[bowerbird](https://github.com/AustralianAntarcticDivision/bowerbird) package for a convenient way to obtain this data set -named "NOAA OI 1/4 Degree Daily SST AVHRR" in the [blueant configuration](https://github.com/AustralianAntarcticDivision/blueant).

    -

    These files can be accessed individually `raster` package function `raster` or as multiple layers with `brick` or `raster::stack`. Use -the `varname` argument to choose one of the four variables.

    -

    To obtain full NetCDF header metadata use 'ncdf4::open.nc(file)' or 'RNetCDF::print.nc(RNetCDF::open.nc(file))' to see -the equivalent of 'ncdump -h' output.

    -

    Optimally Interpolated version 2 SST moved from 'eclipse.ncdc.noaa.gov', to 'www.ncei.noaa.gov' at the end of 2017.

    - - -

    Examples

    - 
    amsr_daily_files()
    #> # A tibble: 5,874 x 3
-#>    date                fullname                                    root         
-#>    <dttm>              <chr>                                       <chr>        
-#>  1 2002-06-19 00:00:00 /rdsi/PUBLIC/raad/data/ftp-projects.cen.un… /rdsi/PUBLIC…
-#>  2 2002-06-20 00:00:00 /rdsi/PUBLIC/raad/data/ftp-projects.cen.un… /rdsi/PUBLIC…
-#>  3 2002-06-21 00:00:00 /rdsi/PUBLIC/raad/data/ftp-projects.cen.un… /rdsi/PUBLIC…
-#>  4 2002-06-22 00:00:00 /rdsi/PUBLIC/raad/data/ftp-projects.cen.un… /rdsi/PUBLIC…
-#>  5 2002-06-23 00:00:00 /rdsi/PUBLIC/raad/data/ftp-projects.cen.un… /rdsi/PUBLIC…
-#>  6 2002-06-24 00:00:00 /rdsi/PUBLIC/raad/data/ftp-projects.cen.un… /rdsi/PUBLIC…
-#>  7 2002-06-25 00:00:00 /rdsi/PUBLIC/raad/data/ftp-projects.cen.un… /rdsi/PUBLIC…
-#>  8 2002-06-26 00:00:00 /rdsi/PUBLIC/raad/data/ftp-projects.cen.un… /rdsi/PUBLIC…
-#>  9 2002-06-27 00:00:00 /rdsi/PUBLIC/raad/data/ftp-projects.cen.un… /rdsi/PUBLIC…
-#> 10 2002-06-28 00:00:00 /rdsi/PUBLIC/raad/data/ftp-projects.cen.un… /rdsi/PUBLIC…
-#> # … with 5,864 more rows
    oisst_daily_files()
    #> # A tibble: 13,777 x 3
-#>    date                fullname                                    root         
-#>    <dttm>              <chr>                                       <chr>        
-#>  1 1981-09-01 00:00:00 /rdsi/PUBLIC/raad/data/www.ncei.noaa.gov/d… /rdsi/PUBLIC…
-#>  2 1981-09-02 00:00:00 /rdsi/PUBLIC/raad/data/www.ncei.noaa.gov/d… /rdsi/PUBLIC…
-#>  3 1981-09-03 00:00:00 /rdsi/PUBLIC/raad/data/www.ncei.noaa.gov/d… /rdsi/PUBLIC…
-#>  4 1981-09-04 00:00:00 /rdsi/PUBLIC/raad/data/www.ncei.noaa.gov/d… /rdsi/PUBLIC…
-#>  5 1981-09-05 00:00:00 /rdsi/PUBLIC/raad/data/www.ncei.noaa.gov/d… /rdsi/PUBLIC…
-#>  6 1981-09-06 00:00:00 /rdsi/PUBLIC/raad/data/www.ncei.noaa.gov/d… /rdsi/PUBLIC…
-#>  7 1981-09-07 00:00:00 /rdsi/PUBLIC/raad/data/www.ncei.noaa.gov/d… /rdsi/PUBLIC…
-#>  8 1981-09-08 00:00:00 /rdsi/PUBLIC/raad/data/www.ncei.noaa.gov/d… /rdsi/PUBLIC…
-#>  9 1981-09-09 00:00:00 /rdsi/PUBLIC/raad/data/www.ncei.noaa.gov/d… /rdsi/PUBLIC…
-#> 10 1981-09-10 00:00:00 /rdsi/PUBLIC/raad/data/www.ncei.noaa.gov/d… /rdsi/PUBLIC…
-#> # … with 13,767 more rows
    -
    - -
    - -
    -
    -

    Developed by Michael D. Sumner.

    -
    - -
    -

    Site built with pkgdown 1.3.0.

    -
    -
    -
    - - - - - - diff --git a/docs/reference/raadfiles-admin.html b/docs/reference/raadfiles-admin.html deleted file mode 100644 index c62a39d..0000000 --- a/docs/reference/raadfiles-admin.html +++ /dev/null @@ -1,247 +0,0 @@ - - - - - - - - -Raadfiles administration tools — raadfiles-admin • raadfiles - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    -
    - - - -
    - -
    -
    -
    -

    Raadfiles administration tools

    - - -
    - -
    - -

    Administration tools for managing a data library.

    - -
    - - 
    get_raad_data_roots()
-
-get_raad_filenames()
-
-set_raad_data_roots(..., replace_existing = TRUE,
-  use_known_candidates = FALSE, verbose = TRUE)
-
-raad_filedb_path(...)
-
-set_raad_filenames(clobber = FALSE)
-
-run_build_raad_cache()
    - -

    Arguments

    - - - - - - - - - - - - - - - - - - -
    ...

    input file paths to set

    replace_existing

    replace existing paths, defaults to TRUE

    use_known_candidates

    apply internal logic for known candidates (for internal use at raad-hq), defaults to FALSE

    clobber

    by default do not ignore existing file cache, set to TRUE to ignore and set

    - -

    Details

    - -

    These management functions are aimed at raadtools users, but can be -used for any file collection. The administration tools consist of **data roots** and -control over the building, reading, and caching of the available file list. No -interpretation of the underlying files is provided in the administration tools.

    -

    A typical user won't use these functions but may want to investigate the contents of the raw file list, with -`get_raad_filenames()`.

    -

    A user setting up a raadfiles collection will typically set the root directory/directories with `set_raad_data_roots()`, -then run the file cache list builder with `run_build_raad_cache()`, and then `set_raad_filenames()` -to actually load the file cache into memory.

    -

    In a new R session there is no need to run `set_raad_filenames()` directly as this -will be done as the package loads. To disable this automatic behaviour use `options(raadfiles.file.cache.disable = TRUE)` *before* the package is -used or loaded. This is typically done when calling `run_build_raad_cache()` in a cron task.

    -

    Every raadfiles file collection function (e.g. `oisst_daily_files`) will run `get_raad_filenames` to obtain the full raw list of -available files from the global in-memory option `getOption("raadfiles.filename.database")` and there is a low threshold probability that -this will also trigger a re-read of the file listing from the root directories. To avoid this trigger either use `getOption("raadfiles.filename.database")` -directly to get the in-memory file list, or set `options(raadfiles.file.refresh.threshold = 0)` to prevent the trigger. (Set it to 1 to force it always -to be read, also controlled by `set_raad_filenames(clobber = TRUE)`).

    -

    There is a family of functions and global options used for administration.

    - -

    Administration functions

    - - - - - - - - - - - - - - - - - -
    set_raad_data_roots
    set data root paths, for normal use only one data root is needed
    set_raad_filenames
    runs the system to update the file listing and refresh it
    get_raad_data_roots
    returns the current list of visible root directories
    get_raad_filenames
    returns the entire list of all files found in visible root directories
    run_build_raad_cache
    scan all root directories and update the file listing in each
    - -

    Options for use by administrators

    - - - - - - - - - - - -
    raadfiles.data.roots
    the list of paths to root directories
    raadfiles.file.cache.disable
    disable on-load setting of the in-memory file cache (never set automatically by the package)
    raadfiles.file.refresh.threshold
    threshold probability of how often to refresh in-memory file cache (0 = never, 1 = every time `get_raad_filenames()` is called)
    - -

    Internal options, used by the package

    - - -

    Options used internally, and subject to control by adminstrator options and the running of admin functions (they may not be set).

    - - - - - - - -
    raadfiles.filename.database
    the data frame of all file names from the data roots
    raadfiles.database.status
    a status record of the in-memory filename database (timestamp)
    - - -
    - -
    - -
    -
    -

    Developed by Michael D. Sumner.

    -
    - -
    -

    Site built with pkgdown 1.3.0.

    -
    -
    -
    - - - - - - diff --git a/docs/reference/raadfiles-package.html b/docs/reference/raadfiles-package.html deleted file mode 100644 index 1622657..0000000 --- a/docs/reference/raadfiles-package.html +++ /dev/null @@ -1,150 +0,0 @@ - - - - - - - - -raadfiles: File Database Management for 'raadtools' — raadfiles-package • raadfiles - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    -
    - - - -
    - -
    -
    -
    -

    raadfiles: File Database Management for 'raadtools'

    - - -
    - -
    - -

    Tools for managing collections of files for the 'raad' family.

    - -
    - - -

    See also

    - -

    raadfiles-admin

    - - -
    - -
    - -
    -
    -

    Developed by Michael D. Sumner.

    -
    - -
    -

    Site built with pkgdown 1.3.0.

    -
    -
    -
    - - - - - - diff --git a/docs/reference/rema_8m_files.html b/docs/reference/rema_8m_files.html deleted file mode 100644 index 0d1dc41..0000000 --- a/docs/reference/rema_8m_files.html +++ /dev/null @@ -1,198 +0,0 @@ - - - - - - - - -Files for The Reference Elevation Model of Antarctica (REMA) — rema_8m_files • raadfiles - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    -
    - - - -
    - -
    -
    -
    -

    Files for The Reference Elevation Model of Antarctica (REMA)

    - - -
    - -
    - -

    Return files for various products from REMA Release 1

    - -
    - - 
    rema_tile_files(all = FALSE, ...)
-
-rema_100m_files(filled = TRUE, ...)
-
-rema_200m_files()
-
-rema_1km_files(filled = TRUE, ...)
-
-rema_8m_files(...)
    - -

    Arguments

    - - - - - - - - - - -
    ...
    filled

    return 'filled' variant if available

    - -

    Value

    - -

    data frame of file names

    - -

    Details

    - -

    'rema_8m_files' returns the base level 8 GeoTIFF files, there are 1516 files at 8m resolution.

    - -

    References

    - -

    https://www.pgc.umn.edu/tag/rema/

    - - -

    Examples

    - 
    rema_8m_files()
    #> # A tibble: 1,516 x 2
-#>    fullname                                                    root             
-#>    <chr>                                                       <chr>            
-#>  1 /rdsi/PUBLIC/raad/data/ftp.data.pgc.umn.edu/elev/dem/setsm… /rdsi/PUBLIC/raa…
-#>  2 /rdsi/PUBLIC/raad/data/ftp.data.pgc.umn.edu/elev/dem/setsm… /rdsi/PUBLIC/raa…
-#>  3 /rdsi/PUBLIC/raad/data/ftp.data.pgc.umn.edu/elev/dem/setsm… /rdsi/PUBLIC/raa…
-#>  4 /rdsi/PUBLIC/raad/data/ftp.data.pgc.umn.edu/elev/dem/setsm… /rdsi/PUBLIC/raa…
-#>  5 /rdsi/PUBLIC/raad/data/ftp.data.pgc.umn.edu/elev/dem/setsm… /rdsi/PUBLIC/raa…
-#>  6 /rdsi/PUBLIC/raad/data/ftp.data.pgc.umn.edu/elev/dem/setsm… /rdsi/PUBLIC/raa…
-#>  7 /rdsi/PUBLIC/raad/data/ftp.data.pgc.umn.edu/elev/dem/setsm… /rdsi/PUBLIC/raa…
-#>  8 /rdsi/PUBLIC/raad/data/ftp.data.pgc.umn.edu/elev/dem/setsm… /rdsi/PUBLIC/raa…
-#>  9 /rdsi/PUBLIC/raad/data/ftp.data.pgc.umn.edu/elev/dem/setsm… /rdsi/PUBLIC/raa…
-#> 10 /rdsi/PUBLIC/raad/data/ftp.data.pgc.umn.edu/elev/dem/setsm… /rdsi/PUBLIC/raa…
-#> # … with 1,506 more rows
    rema_100m_files(filled = TRUE)
    #> # A tibble: 1 x 2
-#>   fullname                                                     root             
-#>   <chr>                                                        <chr>            
-#> 1 /rdsi/PUBLIC/raad/data/ftp.data.pgc.umn.edu/elev/dem/setsm/… /rdsi/PUBLIC/raa…
    -
    - -
    - -
    -
    -

    Developed by Michael D. Sumner.

    -
    - -
    -

    Site built with pkgdown 1.3.0.

    -
    -
    -
    - - - - - - diff --git a/docs/reference/smap.html b/docs/reference/smap.html deleted file mode 100644 index 74247df..0000000 --- a/docs/reference/smap.html +++ /dev/null @@ -1,148 +0,0 @@ - - - - - - - - -SMAP ocean surface salinity files — smap • raadfiles - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    -
    - - - -
    - -
    -
    -
    -

    SMAP ocean surface salinity files

    - - -
    - -
    - -

    Remote Sensing Systems SMAP Level 3 Sea Surface Salinity Standard Mapped Image 8day running

    - -
    - - 
    smap_8day_files()
    - -

    Value

    - -

    tibble data frame of file names, with columns `fullname` and `date`

    - - -

    Examples

    - 
    smap_daily_files()
    #> Error in smap_daily_files(): could not find function "smap_daily_files"
    -
    - -
    - -
    -
    -

    Developed by Michael D. Sumner.

    -
    - -
    -

    Site built with pkgdown 1.3.0.

    -
    -
    -
    - - - - - - diff --git a/docs/reference/srtm.html b/docs/reference/srtm.html deleted file mode 100644 index 75abdea..0000000 --- a/docs/reference/srtm.html +++ /dev/null @@ -1,175 +0,0 @@ - - - - - - - - -SRTM files — srtm • raadfiles - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    -
    - - - -
    - -
    -
    -
    -

    SRTM files

    - - -
    - -
    - -

    SRTM 90m Digital Elevation Database v4.1

    - -
    - - 
    srtm_files()
    - -

    Value

    - -

    tibble data frame of file names, with columns `fullname`, `x`, `y` (tiles)

    -

    data frame with `fullname` file path, `x`, `y` tile column and row indices, `lon`, `lat` -a longitude and latitude for each tile, `root` the data file root path

    - -

    Details

    - -

    DOI: 0.1080/13658810601169899

    - -

    References

    - -

    [https://cgiarcsi.community/data/srtm-90m-digital-elevation-database-v4-1/]

    - - -

    Examples

    - 
    srtm_files()
    #> # A tibble: 378 x 6
-#>    fullname                                     x     y   lon   lat root        
-#>    <chr>                                    <int> <int> <dbl> <dbl> <chr>       
-#>  1 /rdsi/PUBLIC/raad/data/srtm.csi.cgiar.o…     1     2 -178.  52.5 /rdsi/PUBLI…
-#>  2 /rdsi/PUBLIC/raad/data/srtm.csi.cgiar.o…     1     7 -178.  27.5 /rdsi/PUBLI…
-#>  3 /rdsi/PUBLIC/raad/data/srtm.csi.cgiar.o…     2     1 -172.  57.5 /rdsi/PUBLI…
-#>  4 /rdsi/PUBLIC/raad/data/srtm.csi.cgiar.o…     2     2 -172.  52.5 /rdsi/PUBLI…
-#>  5 /rdsi/PUBLIC/raad/data/srtm.csi.cgiar.o…     2     7 -172.  27.5 /rdsi/PUBLI…
-#>  6 /rdsi/PUBLIC/raad/data/srtm.csi.cgiar.o…     3     1 -168.  57.5 /rdsi/PUBLI…
-#>  7 /rdsi/PUBLIC/raad/data/srtm.csi.cgiar.o…     3     2 -168.  52.5 /rdsi/PUBLI…
-#>  8 /rdsi/PUBLIC/raad/data/srtm.csi.cgiar.o…     3     8 -168.  22.5 /rdsi/PUBLI…
-#>  9 /rdsi/PUBLIC/raad/data/srtm.csi.cgiar.o…     4     1 -162.  57.5 /rdsi/PUBLI…
-#> 10 /rdsi/PUBLIC/raad/data/srtm.csi.cgiar.o…     4     2 -162.  52.5 /rdsi/PUBLI…
-#> # … with 368 more rows
    -
    - -
    - -
    -
    -

    Developed by Michael D. Sumner.

    -
    - -
    -

    Site built with pkgdown 1.3.0.

    -
    -
    -
    - - - - - - diff --git a/docs/reference/thelist.html b/docs/reference/thelist.html deleted file mode 100644 index a34f931..0000000 --- a/docs/reference/thelist.html +++ /dev/null @@ -1,343 +0,0 @@ - - - - - - - - -TheList — thelist • raadfiles - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    -
    - - - -
    - -
    -
    -
    -

    TheList

    - - -
    - -
    - -

    Local authority spatial data in Tasmania.

    - -
    - - 
    thelist_files(format = c("gdb", "tab", "shp", "asc"), pattern = NULL)
    - -

    Arguments

    - - - - - - - - - - -
    format

    is used to targe tspecific formats see Details

    pattern

    is used to string match generally, if this is not NULL then format is ignored

    - -

    Value

    - -

    tibble data frame of file names

    - -

    Details

    - -

    TheList.tas.gov.au is the standard local mapping authority in Tasmania, it was -recently upgraded and works very well, and most of the data including newish -LiDAR is available within the opendata tree. Also check out tasmap.org for an -alternative interface with access to the same services.

    -

    These files are broken into sub-regions, administrative areas within the -state of Tasmania. At time of checking there were 19 sub-regions, and 544 or so -layers (type within format) and 37,616 total files. GDB detection is different to the other -more definite formats so the file sets won't be analogous atm. There are Climate -Futures Australia (CFA) layer indexes in here as well, it's on the todo list -to build a comprehensive index (or access one).

    -

    The scheme uses the Map Grid of Australia 1994 (MGA94) on -the Geocentric Datum of Australia 1994 (GDA94), an implementation of UTM Zone -55. GDA94 was rolled out in Australia in the early 2000s, Tasmania kept the -old UTM scheme (it was AMG66, AGD66) but around the same time Victoria used -the opportunity to move to a single-projection for the entire state, to avoid -having to switch between zones. NSW took much longer to modernize and -standardize around GDA94 and they stumbled forward with their three UTM zones -(54, 55, 56), and while Tasmania did it quickly we only have the one zone (no -one thought much about Macquarie Island) and Victoria did it more cleverly. -I'm not sure how Queensland went, they were adding properties and roads at a -very scary rate so probably took much longer than us. The software back then -could only just handle an entire city worth of vector roads and cadastre, so -experience with higher abstractions was pretty rare. As a nation, we could -probably never have agreed on a national LCC projection given that the -states had so much mess to sort out themselves, but that's what you see in -the USA with its Albers family, and the elided Hawaii and and Alaskan -montsrosities . During the time GDA94 was being rolled out the addressing -system was being standardized for GPS and modern communication systems, the -P-NAF was the original project that took the data from Australia Post. State -of the art for address parsing in 2002 was Perl, Google Earth was but a -keyhole glimmering in the background in early West Wing episodes, and the -idea of "micro-services" was catching on among the venture capital elite. Today -the echoes of Oracle and ESRI and RP-Data and ENVI and are still with us.

    -

    It was around this time that the large players made their mark in Australia -(mid-1990s-early 2000s), MapInfo had a tight hold on many local government -authorities (LGAs) because they had the best software, the best formats (TAB, -MIF and georeferenced tile TAB for imagery), and somehow got integrated into -many state departments. That's why these TAB and MIF formats are here still, -shp was the poor interchange cousin, limited to DBF, short field names, no -data above the 32-bit index limit, no mixed topologies in a single layer. -Aerial imagery was just starting to make an impact and the future business -and research interests being recognized. MrSID and ECW were used to integrate -large imagery collections into single files and services, while their parent -companies waged a furious legal battle around wavelet compression. LizardTech -has mostly faded from the scene, but NearMap continues today with "reality as -a service", they certainly had the long-game in mind this whole time.

    -

    Manifold was in version 5.0 in 2002, and it could read all of these formats -as well as provide very accessible rendering, ability to create tiles with -links betweeen drawings and images for creating tile sets. ECW was absolutely -hot, and ERMapper (Nearmap) had a free viewer that is probably still the best -one around until leaflet happened. The point of this long story was to -explain that in the early 2000s these files were LARGE and no one had a hope -of reading a road line, cadastral parcel, or even address point shapefile for -an entire state. We read them in parts, and in pairs or more of parts while -we slowly rendered our way around the country building map tile sets -deprecated immediately when Google Earth arrived. These days it's a pain to -get the file list into one object so you lapply it with the latest R GIS i/o -package, but there's really no problem with memory.

    -

    This function is here to make it easy to get the file list for Tasmania.

    -

    tab, gdb, shp is sf/rgdal ready - gdb works with the directory name, it might -work with some of the individual files - I don't know how GDAL otherwise -resolves layer names in the same folder but you can give it the path name, -this is probably why gdb/, though note that for raster /anything-next-to.adf -does work

    -

    tab is that glorious ancient format

    -

    gdb is a newcomer format, recently reverse engineered by Even

    -

    shp is the usual suspect

    -

    dbf is the usual suspect's data (ggplot2 calls this metadata)

    -

    asc is DEM e.g. list_dem_25m_break_o_day.asc (part of a statewide effort in the -early 2000s to build a DEM for Tasmania, it was used to build a networked drainage -and topography graph of the state's physical landscape, and this helped spur the -development of a powerful imagery orthorectification system and led to some -interesting commerical initiatives in general geospatial data)

    -

    csv is something else e.g. list_fmp_data.csv

    -

    txt is probably just xml, probably only relevant to GDAL and ESRI list_fmp_data_statewide.txt.xml

    -

    Arguments are used to pattern match on different aspects of the file name so that anything can be pulled out.

    - - -

    Examples

    - 
    thelist_files()
    #> # A tibble: 834 x 2
-#>    fullname                                                    root             
-#>    <chr>                                                       <chr>            
-#>  1 /rdsi/PUBLIC/raad/data/listdata.thelist.tas.gov.au/opendat… /rdsi/PUBLIC/raa…
-#>  2 /rdsi/PUBLIC/raad/data/listdata.thelist.tas.gov.au/opendat… /rdsi/PUBLIC/raa…
-#>  3 /rdsi/PUBLIC/raad/data/listdata.thelist.tas.gov.au/opendat… /rdsi/PUBLIC/raa…
-#>  4 /rdsi/PUBLIC/raad/data/listdata.thelist.tas.gov.au/opendat… /rdsi/PUBLIC/raa…
-#>  5 /rdsi/PUBLIC/raad/data/listdata.thelist.tas.gov.au/opendat… /rdsi/PUBLIC/raa…
-#>  6 /rdsi/PUBLIC/raad/data/listdata.thelist.tas.gov.au/opendat… /rdsi/PUBLIC/raa…
-#>  7 /rdsi/PUBLIC/raad/data/listdata.thelist.tas.gov.au/opendat… /rdsi/PUBLIC/raa…
-#>  8 /rdsi/PUBLIC/raad/data/listdata.thelist.tas.gov.au/opendat… /rdsi/PUBLIC/raa…
-#>  9 /rdsi/PUBLIC/raad/data/listdata.thelist.tas.gov.au/opendat… /rdsi/PUBLIC/raa…
-#> 10 /rdsi/PUBLIC/raad/data/listdata.thelist.tas.gov.au/opendat… /rdsi/PUBLIC/raa…
-#> # … with 824 more rows
    
-## to get statewide sets, find the individual groups first and pick one
-grps <- raadfiles:::thelist_groups()
-print(grps)
    #>  [1] "10m_contours"                                        
-#>  [2] "2d_building_polys"                                   
-#>  [3] "5m_contours"                                         
-#>  [4] "acid_sulfate_soil_sites_statewide"                   
-#>  [5] "address_points_statewide"                            
-#>  [6] "aerial_photo_centres_statewide"                      
-#>  [7] "aerial_photo_coverages_statewide"                    
-#>  [8] "authority_land"                                      
-#>  [9] "boundary_segs"                                       
-#> [10] "building_pts"                                        
-#> [11] "coastal_acid_sulfate_soils_statewide"                
-#> [12] "coastal_vulnerability_clayey_shores_statewide"       
-#> [13] "coastal_vulnerability_rocky_shores_statewide"        
-#> [14] "coastal_vulnerability_soft_shores_statewide"         
-#> [15] "coastal_vulnerability_unclassified_statewide"        
-#> [16] "coastline_statewide"                                 
-#> [17] "community_facilities"                                
-#> [18] "correlated_reconnaissance_soils_soil_types_statewide"
-#> [19] "crown_leases_statewide"                              
-#> [20] "crown_licences_statewide"                            
-#> [21] "dhhs_ambulance_station_locations_statewide"          
-#> [22] "easements"                                           
-#> [23] "electoral_divs_statewide"                            
-#> [24] "hydarea"                                             
-#> [25] "hydline"                                             
-#> [26] "hydpnt"                                              
-#> [27] "inland_acid_sulfate_soils_statewide"                 
-#> [28] "irrigationia_dams_statewide"                         
-#> [29] "irrigationia_hydropower_statewide"                   
-#> [30] "irrigationia_irrigation_districts_statewide"         
-#> [31] "irrigationia_pipeline_statewide"                     
-#> [32] "irrigationia_pumpstation_statewide"                  
-#> [33] "irrigationia_trade_zone_statewide"                   
-#> [34] "irrigationia_transmission_line_statewide"            
-#> [35] "land capability_statewide"                           
-#> [36] "land_districts_statewide"                            
-#> [37] "land_tenure_statewide"                               
-#> [38] "land_use_2002_BRS_statewide"                         
-#> [39] "land_use_2009_2010_BRS"                              
-#> [40] "land_use_2009_2010_BRS_statewide"                    
-#> [41] "land_use_2013_BRS"                                   
-#> [42] "land_use_2013_BRS_statewide"                         
-#> [43] "land_use_2015_BRS"                                   
-#> [44] "land_use_2015_BRS_statewide"                         
-#> [45] "legislative_council_divs_statewide"                  
-#> [46] "liquor_licences_statewide"                           
-#> [47] "listian_reserve_estate_statewide"                    
-#> [48] "local_govt_areas_statewide"                          
-#> [49] "local_govt_reserves_statewide"                       
-#> [50] "locality_postcode"                                   
-#> [51] "marine_acid_sulfate_soils_statewide"                 
-#> [52] "marine_farming_zones_statewide"                      
-#> [53] "marine_leases_statewide"                             
-#> [54] "marine_nature_reserves_statewide"                    
-#> [55] "named_feature_extent_statewide"                      
-#> [56] "nomenclature_csv_statewide"                          
-#> [57] "nomenclature_statewide"                              
-#> [58] "parcels"                                             
-#> [59] "parish_town_bdys_statewide"                          
-#> [60] "private_reserves_statewide"                          
-#> [61] "private_timber_reserves_statewide"                   
-#> [62] "public_land_class"                                   
-#> [63] "ramsar_wetlands_statewide"                           
-#> [64] "reconnaissance_soils_map_extents_100k_statewide"     
-#> [65] "scalefish_blocks_statewide"                          
-#> [66] "soil_boundaries_statewide"                           
-#> [67] "soil_sample_sites_statewide"                         
-#> [68] "spot_heights_statewide"                              
-#> [69] "survey_control_statewide"                            
-#> [70] "tasveg_20"                                           
-#> [71] "tasveg_20_statewide"                                 
-#> [72] "tasveg_30"                                           
-#> [73] "tasveg_30_groups"                                    
-#> [74] "tasveg_30_groups_statewide"                          
-#> [75] "tasveg_30_statewide"                                 
-#> [76] "threatened_native_vegetation_communities_statewide"  
-#> [77] "transport_nodes"                                     
-#> [78] "transport_segments"                                  
-#> [79] "water_districts_statewide"                           
-#> [80] "water_management_area_statewide"                     
    #read_all <- function(pattern) {
-#files <- thelist_files(format = "shp", pattern = pattern)
-#do.call(rbind, lapply(files$fullname,  sf::read_sf))
-#}
-#x <- read_all(sample(grps, 1))
-
    -
    - -
    - -
    -
    -

    Developed by Michael D. Sumner.

    -
    - -
    -

    Site built with pkgdown 1.3.0.

    -
    -
    -
    - - - - - - diff --git a/docs/reference/topography-files.html b/docs/reference/topography-files.html deleted file mode 100644 index 1dfb002..0000000 --- a/docs/reference/topography-files.html +++ /dev/null @@ -1,258 +0,0 @@ - - - - - - - - -Topographic data files — topography • raadfiles - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    -
    - - - -
    - -
    -
    -
    -

    Topographic data files

    - - -
    - -
    - -

    Obtain file names for various topographic data.

    - -
    - - 
    gebco19_files(all = FALSE, ...)
-
-gebco08_files(all = FALSE, ...)
-
-ramp_files(all = FALSE, ...)
-
-ibcso_files(all = FALSE, ...)
-
-ibcso_background_files(all = FALSE, ...)
-
-ibcso_bed_files(all = FALSE, ...)
-
-ibcso_digital_chart_files(all = FALSE, ...)
-
-ibcso_sid_files(all = FALSE, ...)
-
-cryosat2_files(all = FALSE, ...)
-
-etopo1_files(all = FALSE, ...)
-
-etopo2_files(all = FALSE, ...)
-
-lakesuperior_files(all = FALSE, ...)
-
-kerguelen_files(all = FALSE, ...)
-
-george_v_terre_adelie_1000m_files(all = FALSE, ...)
-
-george_v_terre_adelie_500m_files(all = FALSE, ...)
-
-george_v_terre_adelie_250m_files(all = FALSE, ...)
-
-george_v_terre_adelie_100m_files(all = FALSE, ...)
-
-smith_sandwell_files(all = FALSE, ...)
-
-smith_sandwell_unpolished_files(all = FALSE, ...)
-
-smith_sandwell_lon180_files(all = FALSE, ...)
-
-smith_sandwell_unpolished_lon180_files(all = FALSE, ...)
-
-macquarie100m_57S_files(all = FALSE, ...)
-
-macquarie100m_58S_files(all = FALSE, ...)
    - -

    Arguments

    - - - - - - - - - - -
    all

    return a larger set of files (for exploratory use only)

    ...

    reserved

    - -

    Value

    - -

    data frame of `file` and `fullname` columns

    - -

    Details

    - -

    Each function exists to match a specific data set, but the optional `all` argument may be used to -easily discover a broader set of files that ship with the data, or that represent older versions, documentation -and other metadata files.

    -

    There's no single format, there are GeoTIFFs, ArcInfo binary, ERStorage, NetCDF, NetCDF GMT, (Geo) PDF, and some VRT -wrappers for handling raw binary files.

    - -

    GEBCO General Bathymetric Chart of the Oceans

    - - -

    Two versions 2008 and 2014.

    - -

    IBCSO International Bathymetric Chart of the Southern Ocean

    - - -

    'is' ('is_PS71' tif, or grd), 'background_hq', 'bed' ('bed_PS71'), 'digital_chart', 'sid' ('sid_PS71')

    - -

    ETOPO

    - - -

    Etopo1 and Etopo2, Lake Superior

    - -

    Smith and Sandwell

    - - -

    Polished and unpolished, version 18.1 replaces 18.

    - -

    Cryosat2

    - - -

    Cryosat2

    - -

    Australian Antarctic

    - - -

    George V Terre Adelie, Kerguelen, Macquarie 100m

    - - -

    Examples

    - 
    gebco14_files()
    #> Error in gebco14_files(): could not find function "gebco14_files"
    -
    - -
    - - -
    - - - - - -