Releases: TIBHannover/BacDiveR
Releases · TIBHannover/BacDiveR
Maintenance release
Complete transition to ROpenSci-style API
- NEW API: The deprecations announced in v0.8.0 are now completed: The
bd_retrieve()
family of functions has replacedretrieve_data()
and
retrieve_search_results()
has been renamed tobd_retrieve_by_search()
,
see #96. Please update scripts and other downstream code that use BacDiveR. purrr
is no longer an imported / required dependency, but only suggested
due to use in the introductory vignette, see #98.
New API that conforms to ROpenSci
Added
- NEW API: The
bd_retrieve()
family of functions will replaceretrieve_data()
soon. It consists ofbd_retrieve(id = …)
,bd_retrieve_by_culture(collectionno = …)
,
bd_retrieve_by_sequence(accession = …)
andbd_retrieve_taxon(name = …)
which is more auto-complete-friendly and should help avoid the internal need
to sanitise inputs.
Deprecated
retrieve_data()
has been replaced as described above.retrieve_search_results()
has been renamed tobd_retrieve_by_search()
.- Both old functions will be removed in the next major version. Please update
your BacDiveR-using scripts and other downstream code.
Don't stop, never give up!
- Added a vignette section about mass-downloading datasets.
- Instead of stopping with an error if a search returns no results, BacDiveR now
only warns about this case and returns an empty list (#93). - Estimated download times are now reported before all downloads longer than ca.
30 seconds (#84).
Fix NULL comparison bug
Logic-Checking BacDive Datasets
- added a vignette about Logic-Checking BacDive Datasets
- changed
retrieve_search_results()
to returnNULL
when no results are found, in
order to ease integration of datasets intotestthat
tests. - fixed another JSON whitespace escaping bug (#91; Thanks to @jotech!)
v0.5.0-beta
-
Added syncing of release versions to Zenodo, starting with 10.5281/zenodo.1308061
-
The JSON downloads are no longer purged of all space characters pre-emptively
to prevent jsonlite from complaining about invalid encoding (#43). Instead,
only\r
,\n
and\t
are repaired to\\r
,\\n
and\\t
, which jsonlite
expects. This leads to different output (newline & tabs, where previously only
spaces occured)! Thus, if you are parsing BacDiveR output in any way, you may
need to adjust that. Because I consider this unlikely given the "maturing" status,
and because no API surface was changed, I don't consider this a major change
in the SemVer.org sense.
Zenodo-DOI
BacDiveR 0.4.2
Fixed
- Install errors are now warnings and better advise about fixing them (#62)
BacDiveR 0.4.1
Changed
BacDiveR 0.4.0
Added
- This changelog (see #41)
retrieve_search_results()
, see #61- Architecture Decision records, see #53 &
/docs/arch/adr-*.md
Changed
retrieve_data()
now downloads the dataset(s) by default, not only the ID(s), see #54 & #59- Datasets in the aggregated (large) list are now named according to their
bacdive_ID
s (see #47). Before, the lists were only numbered with1
,2
,3
,
etc.
BacDiveR 0.3.1
Fixed
- An error in the download of a single dataset found through it's culture collection number (see #45)
Added
- Usable example / vignette in the README.md file (see #16)