fetch_vd() now correctly returns all data from datasets over 50 rows.
fetch_vd() also now tells you how much data you are retrieving and a coarse estimate of how long this will take.
New function fetch_vd_counts() allows for quick checking of dataset sizes. This is very important as some datasets in VecDyn are over 40,000 rows long!
All fetch_*() functions (and thus also fetch()) now use parallel data retrieval, even when only 1 connection is used. This seems to lead to a 20% gain in download speed for no cost.
ohvbd 0.5.0
Major API change
get_ functions have been split into two new types of function, based upon exact usage.
find_ functions retrieve metadata such as column definitions and ids.
fetch_ functions retrieve actual datasets.
New set of S3 classes (ohvbd.ids, ohvbd.responses, ohvbd.data.frame, ohvbd.ad.matrix) to allow for nicer checks of data integrity.
This has the side effect of no longer falsely triggering the data continuity checks of fetch_ functions when indexing the output of find_x_ids() functions.
New convenience functions fetch() and extract() leverage method dispatch along with the above classes to infer the correct underlying fetch_ and extract_ functions to use.
As such you can now write code such as find_vt_ids() %>% fetch() %>% extract() without having to remember the correct extractor to use.
You can still use the specific extractor functions as before should you desire.
All major functions interfacing with AD, VD, and VT output one of these classes.
Cached data from AD now contains an attribute to signify that it is cached.
New classes are subclassed from other base R classes, and so mostly behave in the same way (i.e. you can subset an ohvbd.data.frame in the same way as just subsetting a normal df).
New function ohvbd.ids() allows users to create objects of the same S3 class as output by the find_ and search_ functions.
New is_cached() function enables a simple check to see if an object has been loaded from the cache by ohvbd.
New function check_ohvbd_config() allows easy printing of the current status of ohvbd’s options.
New clean_ad_cache() function enables users to clean their cached AREAdata files easily.
Build timings now appear in all vignettes.
Cli outputs are now suppressed when running vignettes in non-interactive mode (e.g. while knitting).
Default cache path is now in the user directory (obtained from tools::R_user_dir()).
use-areadata vignette now has part of its content complete.
Generally this update is setting the stage for another major API overhaul in 0.5.0.
ohvbd 0.4.3
Large changes to all vb get_ and search_ function error handling
All of these functions now check automatically for SSL issues, and recommend set_ohvbd_compat() if these are detected.
All get_ calls requesting more than 10 ids run a pre-flight ssl check before attempting the whole thing.
get_vd() and get_vt() now also return a list of ids that were missing and any curl errors that were found in the process of trying to get data.
ohvbd 0.4.2
set_ohvbd_compat() now asks for user confirmation in interactive mode. This makes running on linux a little annoying, but is worth it due to the seriousness of disabling SSL identity verification.
This is not asked if the R session is running in batch mode, under knittr, or under testthat.
retrieving-data vignette now only enables compatibility mode if running under linux. Generally it is best to keep package usage of set_ohvbd_compat() to an absolute minimum.
Copyright holder now listed in DESCRIPTION
ohvbd 0.4.1
New parallel downloading options for get_x() and get_extract_x() functions.
These are to be used with caution, as they put significantly more load on the server than a sequential run would.
New argument check_src allows for toggling of id-sanity checking for most functions.
retrieving-data vignette now contains instructions for the use of search_x_smart().
If a function does multiple things, it may get multiple verbs separated by underscores, e.g. get_extract_x_chunked()
Pipelines now internally attempt to confirm data integrity by checking that the correct functions are piped together.
This means it is no longer easy to accidentally do something like get_vd_current_ids() %>% get_vt().
ohvbd 0.3.1
New function format_time_overlap_bar() allows for visually formatting a range of dates combined with another set of target dates to see where overlaps do or do not take place.
This is mostly used in the error handling of extract_ad() however it can also be used independently. It was designed to fill a more general role within UI design using the cli package, and should be usable (or hackable) by others needing the same tool.
extract_ad() now errors when all targetdate entries are outside of the range of the AREAdata dataset.
New assoc_ad() associates arbitrary data including lon/lat columns with AREAdata.
New get_vd_columns() provides quick reference about the currently present VecDyn columns. (This is currently not possible for VecTraits, but the feasibility is being investigated.)
New assoc_gadm() function associates gadm ids at all spatial scales with arbitrary data that include lon/lat columns.
Documentation now correctly displays favicons.
Logo now rotates through a variety of colourschemes according to the version number.
ohvbd 0.3.0
Major API change
*_basereq() calls are no longer required as the first argument for functions.
As such, data downloads no longer need to start with vb_basereq() %>%.
Basereq can now be overridden by providing an alternative basereq to the basereq argument of these functions, which can be generated using vb_basereq().
This is usually only needed if using the argument unsafe = TRUE for vb_basereq().
It is also possible to set ohvbd to use compatability-mode ssl calls using set_ohvbd_compat().
This change breaks any code written prior to this version, and so major rewrites may be required.
ohvbd 0.2.5
extract_ad() now allows targetdate to be specified as a vector of full dates, e.g. c("2023-08-04", "2023-09-21").
ohvbd 0.2.4
VecTraits & VecDyn search functions no longer return stale responses if the search fails.
ohvbd 0.2.3
VecTraits functions now use the cli package to provide a nicer cli interface.
VecDyn functions now use the cli package to provide a nicer cli interface.
ohvbd 0.2.2
AREAdata functions now use the cli package to provide a nicer cli interface.
retrieving-data vignette now builds significantly quicker.
ohvbd 0.2.1
get_ad() now caches data from AREAdata to reduce extraneous data downloading and speed up re-execution and development.
This requires the new argument use_cache=TRUE and caches by default in the user directory.
ohvbd 0.2.0
Install instructions now include the correct command for building vignettes when installing from GitHub.
New check_db_status() allows for easy checking of the online status of various data providers.
ohvbd now interfaces with the AREAdata repository for historical climate data.
This includes functions to get and filter AREAdata datasets at different spatial scales.
ohvbd 0.1.4
Small framing change in retrieving-data vignette (courtesy of @willpearse).
ohvbd 0.1.3
New retrieving-data vignette to explain the basic process of downloading and extracting data from Vectraits and VecDyn.
