diff --git a/DESCRIPTION b/DESCRIPTION index 83879d8..28f988f 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,7 +1,7 @@ Package: bowerbird Type: Package Title: Keep a Collection of Sparkly Data Resources -Version: 0.16.0 +Version: 0.16.1 Authors@R: c(person("Ben", "Raymond", email = "ben.raymond@aad.gov.au", role = c("aut", "cre")), person("Michael", "Sumner", role = "aut"), person("Miles", "McBain", email = "miles.mcbain@gmail.com", role = c("rev", "ctb")), diff --git a/docs/404.html b/docs/404.html index eca1732..74d088d 100644 --- a/docs/404.html +++ b/docs/404.html @@ -6,7 +6,7 @@ Page not found (404) • bowerbird - + @@ -32,7 +32,7 @@ bowerbird - 0.15.0 + 0.16.1 @@ -100,7 +100,7 @@

Page not found (404)

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.0.9.

diff --git a/docs/CODE_OF_CONDUCT.html b/docs/CODE_OF_CONDUCT.html index 5e8637a..f4b1bfe 100644 --- a/docs/CODE_OF_CONDUCT.html +++ b/docs/CODE_OF_CONDUCT.html @@ -1,5 +1,5 @@ -Contributor Code of Conduct • bowerbirdContributor Code of Conduct • bowerbird @@ -17,7 +17,7 @@ bowerbird - 0.15.0 + 0.16.1 @@ -81,7 +81,7 @@

Contributor Code of Conduct

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.0.9.

diff --git a/docs/CONTRIBUTING.html b/docs/CONTRIBUTING.html index df7a916..8144670 100644 --- a/docs/CONTRIBUTING.html +++ b/docs/CONTRIBUTING.html @@ -1,5 +1,5 @@ -Contributions • bowerbirdContributions • bowerbird @@ -17,7 +17,7 @@ bowerbird - 0.15.0 + 0.16.1 @@ -83,7 +83,7 @@

Code of Conduct
-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.0.9.

diff --git a/docs/LICENSE-text.html b/docs/LICENSE-text.html index 00e29e6..e76482a 100644 --- a/docs/LICENSE-text.html +++ b/docs/LICENSE-text.html @@ -1,5 +1,5 @@ -License • bowerbirdLicense • bowerbird @@ -17,7 +17,7 @@ bowerbird - 0.15.0 + 0.16.1 @@ -75,7 +75,7 @@

License

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.0.9.

diff --git a/docs/articles/bowerbird.html b/docs/articles/bowerbird.html index 04d8254..7864bae 100644 --- a/docs/articles/bowerbird.html +++ b/docs/articles/bowerbird.html @@ -6,7 +6,7 @@ Bowerbird • bowerbird - + @@ -33,7 +33,7 @@ bowerbird - 0.15.0 + 0.16.1 @@ -82,7 +82,7 @@

Bowerbird

Ben Raymond, Michael Sumner

-

2024-03-08

+

2024-08-16

Source: vignettes/bowerbird.Rmd @@ -673,6 +673,41 @@

Choosing a data directory
+

Synchronizing to object storage +

+

As of bowerbird v0.17 (August 2024) it is possible to synchronize +directly into an object store like AWS S3, rather than to a directory on +your local file system. This works for data sources using the +bb_handler_rget, bb_handler_earthdata, or +bb_handler_oceandata handlers. To do this, provide +target_s3_args as part of your data source definition:

+
my_source <- bb_example_sources("Australian Election 2016 House of Representatives data") %>%
+  bb_modify_source(method = list(target_s3_args = list(base_url = "my.objectstore.com", region = "",
+                                     bucket = "bucket", key = "KEY", secret = "SECRET"))
+

where the entries in target_s3_args are those required +by functions from the aws.s3 package (see +aws.s3::s3HTTP() for an overview). Objects will be stored +with keys that follow the directory hierarchy on the remote data source. +For example, +http://www.somewhere.org/monkey/banana/dataset.zip will be +stored in the specified bucket with key +www.somewhere.org/monkey/banana/dataset.zip. You can remove +the host name from this key by adding no_host = TRUE to the +data source’s method parameters; similarly, leading levels of the +directory hierarchy can be dropped with the cut_dirs +parameter: see bb_rget() for details.

+

target_s3_args can also be specified as part of +bb_config() to avoid having to provide the same parameters +to multiple data sources:

+
+cf <- bb_config(target_s3_args = list(base_url = "my.objectstore.com", region = "",
+                                      key = "KEY", secret = "SECRET")) %>%
+    bb_add(my_source_1 %>%
+             bb_modify_source(method = list(target_s3_args = list(bucket = "bucket1")))) %>%
+    bb_add(my_source_2 %>%
+             bb_modify_source(method = list(target_s3_args = list(bucket = "bucket2"))))
+
+

Post-processing

@@ -710,7 +745,7 @@
Authentication -
+
 mysrc <- bb_example_sources("CMEMS global gridded SSH reprocessed (1993-ongoing)")
 mysrc$user <- "yourusername"
 mysrc$password <- "yourpassword"
@@ -740,7 +775,7 @@ 
Reducing download sizesaccept option. Here we use the bb_modify_source helper function to do so:

-
+
 mysrc <- bb_example_sources("CMEMS global gridded SSH reprocessed (1993-ongoing)") %>%
   bb_modify_source(user = "yourusername", password = "yourpassword",
     method = list(accept_follow = "/2017"))
@@ -823,7 +858,7 @@ 
CMEMS global gridded

Authentication note: Copernicus Marine login required, see http://marine.copernicus.eu/services-portfolio/register-now/

Approximate size: 310 GB

-

Documentation link: http://marine.copernicus.eu/services-portfolio/access-to-products/?option=com_csw&view=details&product_id=SEALEVEL_GLO_PHY_L4_REP_OBSERVATIONS_008_047

+

Documentation link: https://data.marine.copernicus.eu/product/SEALEVEL_GLO_PHY_L4_MY_008_047/description

@@ -927,7 +962,7 @@
Bathymetry of Lake Superior

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.0.9.

diff --git a/docs/articles/data_provenance.html b/docs/articles/data_provenance.html index 1ecfb61..a0a4570 100644 --- a/docs/articles/data_provenance.html +++ b/docs/articles/data_provenance.html @@ -6,7 +6,7 @@ Data provenance • bowerbird - + @@ -33,7 +33,7 @@ bowerbird - 0.15.0 + 0.16.1
@@ -82,7 +82,7 @@

Data provenance

Ben Raymond, Michael Sumner

-

2024-03-08

+

2024-08-16

Source: vignettes/data_provenance.Rmd @@ -130,8 +130,8 @@

Which files were used in an analys knitr::kable(data.frame(name = cf$data_sources$name, source_dir = source_dirs))

--++ @@ -140,7 +140,7 @@

Which files were used in an analys

- + - + - + + + @@ -173,7 +177,7 @@

All functions

name
NOAA OI SST V2/some/local/path/ftp.cdc.noaa.gov/Datasets/noaa.oisst.v2//some/local/path/downloads.psl.noaa.gov/Datasets/noaa.oisst.v2/
Australian Election 2016 House of Representatives @@ -150,11 +150,11 @@

Which files were used in an analys

CMEMS global gridded SSH reprocessed (1993-ongoing)/some/local/path/ftp.sltac.cls.fr/Core/SEALEVEL_GLO_PHY_L4_REP_OBSERVATIONS_008_047/dataset-duacs-rep-global-merged-allsat-phy-l4-v3//some/local/path/data.marine.copernicus.eu/SEALEVEL_GLO_PHY_L4_MY_008_047
Oceandata SeaWiFS Level-3 mapped monthly 9km chl-a/some/local/path/oceandata.sci.gsfc.nasa.gov/SeaWiFS/Mapped/some/local/path/oceandata.sci.gsfc.nasa.gov/SeaWiFS/Mapped/Monthly/9km/chlor
Sea Ice Trends and Climatologies from SMMR and @@ -260,7 +260,7 @@

A word on digital object identifie

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.0.9.

diff --git a/docs/articles/index.html b/docs/articles/index.html index 75506d5..e97a553 100644 --- a/docs/articles/index.html +++ b/docs/articles/index.html @@ -1,5 +1,5 @@ -Articles • bowerbirdArticles • bowerbird @@ -17,7 +17,7 @@ bowerbird - 0.15.0 + 0.16.1 @@ -74,7 +74,7 @@

All vignettes

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.0.9.

diff --git a/docs/authors.html b/docs/authors.html index 727b78c..2aa88a8 100644 --- a/docs/authors.html +++ b/docs/authors.html @@ -1,5 +1,5 @@ -Authors and Citation • bowerbirdAuthors and Citation • bowerbird @@ -17,7 +17,7 @@ bowerbird - 0.15.0 + 0.16.1 @@ -54,7 +54,7 @@
@@ -85,13 +85,13 @@

Citation

Raymond B, Sumner M (2024). bowerbird: Keep a Collection of Sparkly Data Resources. -R package version 0.15.0, https://github.com/ropensci/bowerbird, https://docs.ropensci.org/bowerbird. +R package version 0.16.1, https://github.com/ropensci/bowerbird, https://docs.ropensci.org/bowerbird.

@Manual{,
   title = {bowerbird: Keep a Collection of Sparkly Data Resources},
   author = {Ben Raymond and Michael Sumner},
   year = {2024},
-  note = {R package version 0.15.0, https://github.com/ropensci/bowerbird},
+  note = {R package version 0.16.1, https://github.com/ropensci/bowerbird},
   url = {https://docs.ropensci.org/bowerbird},
 }
@@ -106,7 +106,7 @@

Citation

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.0.9.

diff --git a/docs/index.html b/docs/index.html index c52b699..56f59d5 100644 --- a/docs/index.html +++ b/docs/index.html @@ -6,14 +6,13 @@ Keep a Collection of Sparkly Data Resources • bowerbird - + - + Generate a bowerbird data source object for an Australian Antarctic Data Centre data set — bb_aadc_source • bowerbirdGenerate a bowerbird data source object for an Australian Antarctic Data Centre data set — bb_aadc_source • bowerbird @@ -17,7 +17,7 @@ bowerbird - 0.15.0 + 0.16.1 @@ -125,7 +125,7 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.0.9.

diff --git a/docs/reference/bb_add.html b/docs/reference/bb_add.html index ed9d009..6f5dcff 100644 --- a/docs/reference/bb_add.html +++ b/docs/reference/bb_add.html @@ -1,5 +1,5 @@ -Add new data sources to a bowerbird configuration — bb_add • bowerbirdAdd new data sources to a bowerbird configuration — bb_add • bowerbird @@ -17,7 +17,7 @@ bowerbird - 0.15.0 + 0.16.1 @@ -107,7 +107,7 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.0.9.

diff --git a/docs/reference/bb_cleanup.html b/docs/reference/bb_cleanup.html index 2dac092..98bfc3f 100644 --- a/docs/reference/bb_cleanup.html +++ b/docs/reference/bb_cleanup.html @@ -1,5 +1,5 @@ -Postprocessing: remove unwanted files — bb_cleanup • bowerbirdPostprocessing: remove unwanted files — bb_cleanup • bowerbird @@ -17,7 +17,7 @@ bowerbird - 0.15.0 + 0.16.1 @@ -130,7 +130,7 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.0.9.

diff --git a/docs/reference/bb_config.html b/docs/reference/bb_config.html index 90e7328..0b52650 100644 --- a/docs/reference/bb_config.html +++ b/docs/reference/bb_config.html @@ -1,5 +1,5 @@ -Initialize a bowerbird configuration — bb_config • bowerbirdInitialize a bowerbird configuration — bb_config • bowerbird @@ -17,7 +17,7 @@ bowerbird - 0.15.0 + 0.16.1 @@ -66,6 +66,7 @@

Initialize a bowerbird configuration

bb_config(
   local_file_root,
   wget_global_flags = list(restrict_file_names = "windows", progress = "dot:giga"),
+  target_s3_args = list(),
   http_proxy = NULL,
   ftp_proxy = NULL,
   clobber = 1
@@ -82,6 +83,10 @@ 

Arguments

list: wget flags that will be applied to all data sources that call bb_wget. These will be appended to the data-source-specific wget flags provided via the source's method argument

+
target_s3_args
+

list: arguments to pass to aws.s3 function calls. Will be used for all data sets that are uploading to s3 targets

+ +
http_proxy

string: URL of HTTP proxy to use e.g. 'http://your.proxy:8080' (NULL for no proxy)

@@ -135,7 +140,7 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.0.9.

diff --git a/docs/reference/bb_data_source_dir.html b/docs/reference/bb_data_source_dir.html index e20bcba..bc326fe 100644 --- a/docs/reference/bb_data_source_dir.html +++ b/docs/reference/bb_data_source_dir.html @@ -1,5 +1,5 @@ -Return the local directory of each data source in a configuration — bb_data_source_dir • bowerbirdReturn the local directory of each data source in a configuration — bb_data_source_dir • bowerbird @@ -17,7 +17,7 @@ bowerbird - 0.15.0 + 0.16.1 @@ -84,12 +84,12 @@

Examples

cf <- bb_config("/my/file/root") %>%
   bb_add(bb_example_sources())
 bb_data_source_dir(cf)
-#> [1] "/my/file/root/ftp.cdc.noaa.gov/Datasets/noaa.oisst.v2/"                                                                            
-#> [2] "/my/file/root/results.aec.gov.au/20499/Website/"                                                                                   
-#> [3] "/my/file/root/ftp.sltac.cls.fr/Core/SEALEVEL_GLO_PHY_L4_REP_OBSERVATIONS_008_047/dataset-duacs-rep-global-merged-allsat-phy-l4-v3/"
-#> [4] "/my/file/root/oceandata.sci.gsfc.nasa.gov/SeaWiFS/Mapped"                                                                          
-#> [5] "/my/file/root/daacdata.apps.nsidc.org/pub/DATASETS/nsidc0192_seaice_trends_climo_v3/"                                              
-#> [6] "/my/file/root/www.ngdc.noaa.gov/mgg/greatlakes/superior/data/"                                                                     
+#> [1] "/my/file/root/downloads.psl.noaa.gov/Datasets/noaa.oisst.v2/"                        
+#> [2] "/my/file/root/results.aec.gov.au/20499/Website/"                                     
+#> [3] "/my/file/root/data.marine.copernicus.eu/SEALEVEL_GLO_PHY_L4_MY_008_047"              
+#> [4] "/my/file/root/oceandata.sci.gsfc.nasa.gov/SeaWiFS/Mapped/Monthly/9km/chlor"          
+#> [5] "/my/file/root/daacdata.apps.nsidc.org/pub/DATASETS/nsidc0192_seaice_trends_climo_v3/"
+#> [6] "/my/file/root/www.ngdc.noaa.gov/mgg/greatlakes/superior/data/"                       
 
 
@@ -105,7 +105,7 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.0.9.

diff --git a/docs/reference/bb_data_sources.html b/docs/reference/bb_data_sources.html index aad6f70..b704c2e 100644 --- a/docs/reference/bb_data_sources.html +++ b/docs/reference/bb_data_sources.html @@ -1,5 +1,5 @@ -Gets or sets a bowerbird configuration object's data sources — bb_data_sources • bowerbirdGets or sets a bowerbird configuration object's data sources — bb_data_sources • bowerbird @@ -17,7 +17,7 @@ bowerbird - 0.15.0 + 0.16.1 @@ -108,7 +108,7 @@

Examples

#> <chr> <chr> <chr> <chr> <list> <chr> <chr> <chr> #> 1 oisst.v2 NOAA… "Weekly an… http:/… <chr [1]> "NOAA_O… Please… NA #> 2 aus-election-ho… Aust… "House of … http:/… <chr [1]> "Copyri… CC-BY NA -#> 3 SEALEVEL_GLO_PH… CMEM… "For the G… http:/… <chr [1]> "In cas… See ht… NA +#> 3 SEALEVEL_GLO_PH… CMEM… "For the G… https:… <chr [1]> "In cas… See ht… NA #> 4 SeaWiFS_L3m_MO_… Ocea… "Monthly r… https:… <chr [1]> "See ht… Please… NA #> 5 10.5067/IJ0T7HF… Sea … "NSIDC pro… https:… <chr [1]> "Stroev… Please… NA #> 6 greatlakes-supe… Bath… "A draft v… https:… <chr [1]> "Publis… https:… Only t… @@ -135,7 +135,7 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.0.9.

diff --git a/docs/reference/bb_decompress.html b/docs/reference/bb_decompress.html index 507f58e..c5133f6 100644 --- a/docs/reference/bb_decompress.html +++ b/docs/reference/bb_decompress.html @@ -1,5 +1,5 @@ -Postprocessing: decompress zip, gz, bz2, tar, Z files and optionally delete the compressed copy — bb_decompress • bowerbirdPostprocessing: decompress zip, gz, bz2, tar, Z files and optionally delete the compressed copy — bb_decompress • bowerbird @@ -17,7 +17,7 @@ bowerbird - 0.15.0 + 0.16.1 @@ -130,7 +130,7 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.0.9.

diff --git a/docs/reference/bb_example_sources.html b/docs/reference/bb_example_sources.html index 142115a..d7adfe8 100644 --- a/docs/reference/bb_example_sources.html +++ b/docs/reference/bb_example_sources.html @@ -1,5 +1,5 @@ -Example bowerbird data sources — bb_example_sources • bowerbirdExample bowerbird data sources — bb_example_sources • bowerbird @@ -17,7 +17,7 @@ bowerbird - 0.15.0 + 0.16.1 @@ -122,7 +122,7 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.0.9.

diff --git a/docs/reference/bb_find_wget.html b/docs/reference/bb_find_wget.html index d09a5f4..c944d3a 100644 --- a/docs/reference/bb_find_wget.html +++ b/docs/reference/bb_find_wget.html @@ -1,5 +1,5 @@ -Find the wget executable — bb_find_wget • bowerbirdFind the wget executable — bb_find_wget • bowerbird @@ -17,7 +17,7 @@ bowerbird - 0.15.0 + 0.16.1 @@ -112,7 +112,7 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.0.9.

diff --git a/docs/reference/bb_fingerprint.html b/docs/reference/bb_fingerprint.html index d11a40d..f921973 100644 --- a/docs/reference/bb_fingerprint.html +++ b/docs/reference/bb_fingerprint.html @@ -1,5 +1,5 @@ -Fingerprint the files associated with a data source — bb_fingerprint • bowerbirdFingerprint the files associated with a data source — bb_fingerprint • bowerbird @@ -17,7 +17,7 @@ bowerbird - 0.15.0 + 0.16.1 @@ -113,7 +113,7 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.0.9.

diff --git a/docs/reference/bb_get.html b/docs/reference/bb_get.html index 923fd83..d045708 100644 --- a/docs/reference/bb_get.html +++ b/docs/reference/bb_get.html @@ -1,5 +1,5 @@ -Convenience function to define and synchronize a bowerbird data collection — bb_get • bowerbirdConvenience function to define and synchronize a bowerbird data collection — bb_get • bowerbird @@ -17,7 +17,7 @@ bowerbird - 0.15.0 + 0.16.1 @@ -179,7 +179,7 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.0.9.

diff --git a/docs/reference/bb_handler_aws_s3.html b/docs/reference/bb_handler_aws_s3.html index dab26a0..7fd2d65 100644 --- a/docs/reference/bb_handler_aws_s3.html +++ b/docs/reference/bb_handler_aws_s3.html @@ -1,5 +1,5 @@ -Handler for public AWS S3 data sources — bb_handler_aws_s3 • bowerbird bowerbird - 0.15.0 + 0.16.1 @@ -137,7 +137,7 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.0.9.

diff --git a/docs/reference/bb_handler_copernicus.html b/docs/reference/bb_handler_copernicus.html index d9d4c4c..01d18f0 100644 --- a/docs/reference/bb_handler_copernicus.html +++ b/docs/reference/bb_handler_copernicus.html @@ -1,5 +1,5 @@ -Handler for Copernicus Marine datasets — bb_handler_copernicus • bowerbirdHandler for Copernicus Marine datasets — bb_handler_copernicus • bowerbird @@ -17,7 +17,7 @@ bowerbird - 0.15.0 + 0.16.1 @@ -107,7 +107,7 @@

References

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.0.9.

diff --git a/docs/reference/bb_handler_earthdata.html b/docs/reference/bb_handler_earthdata.html index 2c8191e..d2b00a0 100644 --- a/docs/reference/bb_handler_earthdata.html +++ b/docs/reference/bb_handler_earthdata.html @@ -1,5 +1,5 @@ -Handler for data sets from Earthdata providers — bb_handler_earthdata • bowerbirdHandler for data sets from Earthdata providers — bb_handler_earthdata • bowerbird @@ -17,7 +17,7 @@ bowerbird - 0.15.0 + 0.16.1 @@ -80,7 +80,7 @@

Value

Details

-

This function uses bb_rget, and so data sources using this function will need to provide appropriate bb_rget parameters.

+

This function uses bb_rget, and so data sources using this function will need to provide appropriate bb_rget parameters. Note that curl v5.2.1 introduced a breaking change to the default value of the `unrestricted_auth` option: see <https://github.com/jeroen/curl/issues/260>. Your Earthdata source definition might require `allow_unrestricted_auth = TRUE` as part of the method parameters.

References

@@ -95,7 +95,7 @@

Examples

my_source <- bb_source( name = "Sea Ice Trends and Climatologies from SMMR and SSM/I-SSMIS, Version 3", - id = "10.5067/EYICLBOAAJOU", + id = "10.5067/IJ0T7HFHB9Y6", description = "NSIDC provides this data set ... [truncated; see bb_example_data_sources()]", doc_url = "https://nsidc.org/data/NSIDC-0192/versions/3", citation = "Stroeve J, Meier WN (2018) ... [truncated; see bb_example_data_sources()]", @@ -104,8 +104,8 @@

Examples

authentication_note = "Requires Earthdata login, see https://urs.earthdata.nasa.gov/. Note that you will also need to authorize the application 'nsidc-daacdata' (see 'My Applications' at https://urs.earthdata.nasa.gov/profile)", - method = list("bb_handler_earthdata", recursive = TRUE, level = 4, no_parent = TRUE, - relative = TRUE), + method = list("bb_handler_earthdata", level = 4, relative = TRUE, + accept_download = "\\.(s|n|png|txt)$", allow_unrestricted_auth = TRUE), user = "your_earthdata_username", password = "your_earthdata_password", collection_size = 0.02) @@ -125,7 +125,7 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.0.9.

diff --git a/docs/reference/bb_handler_oceandata.html b/docs/reference/bb_handler_oceandata.html index 03634b1..f36687a 100644 --- a/docs/reference/bb_handler_oceandata.html +++ b/docs/reference/bb_handler_oceandata.html @@ -1,5 +1,5 @@ -Handler for Oceandata data sets — bb_handler_oceandata • bowerbirdHandler for Oceandata data sets — bb_handler_oceandata • bowerbird @@ -17,7 +17,7 @@ bowerbird - 0.15.0 + 0.16.1 @@ -130,7 +130,7 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.0.9.

diff --git a/docs/reference/bb_handler_rget.html b/docs/reference/bb_handler_rget.html index 4207774..70a3a73 100644 --- a/docs/reference/bb_handler_rget.html +++ b/docs/reference/bb_handler_rget.html @@ -1,5 +1,5 @@ -Mirror an external data source using bowerbird's bb_rget utility — bb_handler_rget • bowerbirdMirror an external data source using bowerbird's bb_rget utility — bb_handler_rget • bowerbird @@ -17,7 +17,7 @@ bowerbird - 0.15.0 + 0.16.1 @@ -125,7 +125,7 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.0.9.

diff --git a/docs/reference/bb_handler_wget.html b/docs/reference/bb_handler_wget.html index 025b395..fa18204 100644 --- a/docs/reference/bb_handler_wget.html +++ b/docs/reference/bb_handler_wget.html @@ -1,5 +1,5 @@ -Mirror an external data source using the wget utility — bb_handler_wget • bowerbirdMirror an external data source using the wget utility — bb_handler_wget • bowerbird @@ -17,7 +17,7 @@ bowerbird - 0.15.0 + 0.16.1 @@ -117,7 +117,7 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.0.9.

diff --git a/docs/reference/bb_install_wget.html b/docs/reference/bb_install_wget.html index 8adb32c..3e8564b 100644 --- a/docs/reference/bb_install_wget.html +++ b/docs/reference/bb_install_wget.html @@ -1,5 +1,5 @@ -Install wget — bb_install_wget • bowerbirdInstall wget — bb_install_wget • bowerbird @@ -17,7 +17,7 @@ bowerbird - 0.15.0 + 0.16.1 @@ -114,7 +114,7 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.0.9.

diff --git a/docs/reference/bb_modify_source.html b/docs/reference/bb_modify_source.html index a476b64..b197d61 100644 --- a/docs/reference/bb_modify_source.html +++ b/docs/reference/bb_modify_source.html @@ -1,5 +1,5 @@ -Modify a data source — bb_modify_source • bowerbirdModify a data source — bb_modify_source • bowerbird @@ -17,7 +17,7 @@ bowerbird - 0.15.0 + 0.16.1 @@ -156,7 +156,7 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.0.9.

diff --git a/docs/reference/bb_oceandata_cleanup.html b/docs/reference/bb_oceandata_cleanup.html new file mode 100644 index 0000000..9fe531c --- /dev/null +++ b/docs/reference/bb_oceandata_cleanup.html @@ -0,0 +1,109 @@ + +Postprocessing: remove redundant NRT oceandata files — bb_oceandata_cleanup • bowerbird + + +
+
+ + + +
+
+ + +
+

This function is not intended to be called directly, but rather is specified as a postprocess option in bb_source.

+
+ +
+
bb_oceandata_cleanup(...)
+
+ +
+

Arguments

+
...
+

: extra parameters passed automatically by bb_sync

+ +
+
+

Value

+ + +

a list, with components status (TRUE on success) and deleted_files (character vector of paths of files that were deleted)

+
+
+

Details

+

This function will remove near-real-time (NRT) files from an oceandata collection that have been superseded by their non-NRT versions.

+
+ +
+ +
+ + +
+ +
+

Site built with pkgdown 2.0.9.

+
+ +
+ + + + + + + + diff --git a/docs/reference/bb_rget.html b/docs/reference/bb_rget.html index b6e6cfe..521216b 100644 --- a/docs/reference/bb_rget.html +++ b/docs/reference/bb_rget.html @@ -1,5 +1,5 @@ -A recursive download utility — bb_rget • bowerbirdA recursive download utility — bb_rget • bowerbird @@ -17,7 +17,7 @@ bowerbird - 0.15.0 + 0.16.1 @@ -76,6 +76,7 @@

A recursive download utility

password, clobber = 1, no_parent = TRUE, + no_parent_download = no_parent, no_check_certificate = FALSE, relative = FALSE, remote_time = TRUE, @@ -89,7 +90,8 @@

A recursive download utility

no_host = FALSE, cut_dirs = 0L, link_css = "a", - curl_opts + curl_opts, + target_s3_args ) bb_rget_default_downloads()
@@ -145,6 +147,10 @@

Arguments

logical: if TRUE, do not ever ascend to the parent directory when retrieving recursively. This is TRUE by default, bacause it guarantees that only the files below a certain hierarchy will be downloaded. Note that this check only applies to links on the same host as the starting url. If that URL links to files on another host, those links will be followed (unless relative = TRUE)

+
no_parent_download
+

logical: similar to no_parent, but applies only to download links. A typical use case is to set no_parent to TRUE and no_parent_download to FALSE, in which case the spidering process (following links to find downloadable files) will not ascend to the parent directory, but files can be downloaded from a directory that is not within the parent

+ +
no_check_certificate

logical: if TRUE, don't check the server certificate against the available certificate authorities. Also don't require the URL host name to match the common name presented by the certificate. This option might be useful if trying to download files from a server with an expired certificate, but it is clearly a security risk and so should be used with caution

@@ -178,7 +184,7 @@

Arguments

force_local_filename
-

string: if provided, then the url will be treated as a single URL (no recursion will be conducted). It will be downloaded to a file with this name, in a local directory determined by the url

+

character: if provided, then each url will be treated as a single URL (no recursion will be conducted). It will be downloaded to a file with name given force_local_filename, in a local directory determined by the url. force_local_filename should be a character vector of the same length as the url vector

use_url_directory
@@ -200,6 +206,10 @@

Arguments

curl_opts

named list: options to use with curl downloads, passed to the .list parameter of curl::new_handle

+ +
target_s3_args
+

list: named list or arguments to provide to get_bucket_df and put_object. Files will be uploaded into that bucket instead of the local filesystem

+

Value

@@ -224,7 +234,7 @@

Details

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.0.9.

diff --git a/docs/reference/bb_settings.html b/docs/reference/bb_settings.html index b55be17..5618b7f 100644 --- a/docs/reference/bb_settings.html +++ b/docs/reference/bb_settings.html @@ -1,5 +1,5 @@ -Gets or sets a bowerbird configuration object's settings — bb_settings • bowerbirdGets or sets a bowerbird configuration object's settings — bb_settings • bowerbird @@ -17,7 +17,7 @@ bowerbird - 0.15.0 + 0.16.1 @@ -107,6 +107,9 @@

Examples

#> [1] "dot:giga" #> #> +#> $target_s3_args +#> list() +#> #> $http_proxy #> NULL #> @@ -144,7 +147,7 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.0.9.

diff --git a/docs/reference/bb_source.html b/docs/reference/bb_source.html index 3343a4b..d5ceff3 100644 --- a/docs/reference/bb_source.html +++ b/docs/reference/bb_source.html @@ -1,5 +1,5 @@ -Define a data source — bb_source • bowerbirdDefine a data source — bb_source • bowerbird @@ -17,7 +17,7 @@ bowerbird - 0.15.0 + 0.16.1 @@ -227,7 +227,7 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.0.9.

diff --git a/docs/reference/bb_source_us_buildings.html b/docs/reference/bb_source_us_buildings.html index 224d616..87673e8 100644 --- a/docs/reference/bb_source_us_buildings.html +++ b/docs/reference/bb_source_us_buildings.html @@ -1,5 +1,5 @@ -Example bowerbird data source: Microsoft US Buildings — bb_source_us_buildings • bowerbirdExample bowerbird data source: Microsoft US Buildings — bb_source_us_buildings • bowerbird @@ -17,7 +17,7 @@ bowerbird - 0.15.0 + 0.16.1 @@ -115,7 +115,7 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.0.9.

diff --git a/docs/reference/bb_subset.html b/docs/reference/bb_subset.html index 0d74427..8e7b0c7 100644 --- a/docs/reference/bb_subset.html +++ b/docs/reference/bb_subset.html @@ -1,5 +1,5 @@ -Keep only selected data_sources in a bowerbird configuration — bb_subset • bowerbirdKeep only selected data_sources in a bowerbird configuration — bb_subset • bowerbird @@ -17,7 +17,7 @@ bowerbird - 0.15.0 + 0.16.1 @@ -108,7 +108,7 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.0.9.

diff --git a/docs/reference/bb_summary.html b/docs/reference/bb_summary.html index f0a5fc2..385cbce 100644 --- a/docs/reference/bb_summary.html +++ b/docs/reference/bb_summary.html @@ -1,5 +1,5 @@ -Produce a summary of a bowerbird configuration — bb_summary • bowerbirdProduce a summary of a bowerbird configuration — bb_summary • bowerbird @@ -17,7 +17,7 @@ bowerbird - 0.15.0 + 0.16.1 @@ -138,7 +138,7 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.0.9.

diff --git a/docs/reference/bb_sync.html b/docs/reference/bb_sync.html index 58f8170..e126d1c 100644 --- a/docs/reference/bb_sync.html +++ b/docs/reference/bb_sync.html @@ -1,5 +1,5 @@ -Run a bowerbird data repository synchronization — bb_sync • bowerbirdRun a bowerbird data repository synchronization — bb_sync • bowerbird @@ -17,7 +17,7 @@ bowerbird - 0.15.0 + 0.16.1 @@ -164,7 +164,7 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.0.9.

diff --git a/docs/reference/bb_wget.html b/docs/reference/bb_wget.html index ee9e790..9d4dc95 100644 --- a/docs/reference/bb_wget.html +++ b/docs/reference/bb_wget.html @@ -1,5 +1,5 @@ -Make a wget call — bb_wget • bowerbirdMake a wget call — bb_wget • bowerbird @@ -17,7 +17,7 @@ bowerbird - 0.15.0 + 0.16.1 @@ -241,7 +241,7 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.0.9.

diff --git a/docs/reference/bb_zenodo_source.html b/docs/reference/bb_zenodo_source.html index b7677c1..982d551 100644 --- a/docs/reference/bb_zenodo_source.html +++ b/docs/reference/bb_zenodo_source.html @@ -1,5 +1,5 @@ -Generate a bowerbird data source object for a Zenodo data set — bb_zenodo_source • bowerbirdGenerate a bowerbird data source object for a Zenodo data set — bb_zenodo_source • bowerbird @@ -17,7 +17,7 @@ bowerbird - 0.15.0 + 0.16.1 @@ -117,7 +117,7 @@

Examples

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.0.9.

diff --git a/docs/reference/bowerbird.html b/docs/reference/bowerbird.html index 03ffd42..1ca8be8 100644 --- a/docs/reference/bowerbird.html +++ b/docs/reference/bowerbird.html @@ -1,5 +1,5 @@ -bowerbird — bowerbird • bowerbirdbowerbird — bowerbird • bowerbird @@ -17,7 +17,7 @@ bowerbird - 0.15.0 + 0.16.1 @@ -94,7 +94,7 @@

Author

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.0.9.

diff --git a/docs/reference/index.html b/docs/reference/index.html index b30e390..e56e78f 100644 --- a/docs/reference/index.html +++ b/docs/reference/index.html @@ -1,5 +1,5 @@ -Function reference • bowerbirdFunction reference • bowerbird @@ -17,7 +17,7 @@ bowerbird - 0.15.0 + 0.16.1 @@ -136,6 +136,10 @@

All functions bb_modify_source()

Modify a data source

+

bb_oceandata_cleanup()

+

Postprocessing: remove redundant NRT oceandata files

bb_rget() bb_rget_default_downloads()

Generate a bowerbird data source object for a Zenodo data set

-

bowerbird _PACKAGE bowerbird-package

+

bowerbird bowerbird-package

bowerbird

@@ -189,7 +193,7 @@

All functions
-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.0.9.

diff --git a/docs/reference/reexports.html b/docs/reference/reexports.html index eb66679..ac6f9be 100644 --- a/docs/reference/reexports.html +++ b/docs/reference/reexports.html @@ -1,5 +1,5 @@ -Objects exported from other packages — reexports • bowerbirdObjects exported from other packages — reexports • bowerbird bowerbird - 0.15.0 + 0.16.1 @@ -88,7 +88,7 @@

Objects exported from other packages

-

Site built with pkgdown 2.0.7.

+

Site built with pkgdown 2.0.9.

diff --git a/docs/sitemap.xml b/docs/sitemap.xml index 170b3a3..e0b5dbd 100644 --- a/docs/sitemap.xml +++ b/docs/sitemap.xml @@ -84,6 +84,9 @@ /reference/bb_modify_source.html + + /reference/bb_oceandata_cleanup.html + /reference/bb_rget.html