Releases: AtlasOfLivingAustralia/galah-R
Releases · AtlasOfLivingAustralia/galah-R
v1.4.0
Revamped syntax
ala_
functions are renamed to use the prefixatlas_
. This change reflects their functionality with international atlases (i.e.,atlas_occurrences
,atlas_counts
,atlas_species
,atlas_media
,atlas_taxonomy
,atlas_citation
) (#103)select_taxa
is replaced by 3 functions:galah_identify
,search_taxa
andsearch_identifiers
.galah_identify
is used when building data queries, whereassearch_taxa
andsearch_identifiers
are now exclusively used to search for taxonomic information. Syntax changes are intended to reflect their usage and expected output (#112, #122)select_
functions are renamed to use the prefixgalah_
. Specifically,galah_filter
,galah_select
andgalah_geolocate
replaceselect_filters
,select_columns
andselect_locations
. These syntax changes reflect a move towards consistency withdplyr
naming and functionality (#101, #108)find_
functions that provide a listing of all possible values renamed toshow_all_
(i.e.,show_all_profiles
,show_all_ranks
,show_all_atlases
,show_all_cached_files
,show_all_fields
,show_all_reasons
).find_
functions that require and input and return specific results renamed tosearch_
(i.e.,search_field_values
,search_profile_attributes
) (#112, #113)
galah_group_by
- Group fields using
galah_group_by()
, which groups and summarises record counts based on categorical field values, similar todplyr::group_by()
(#90, #95)
galah_down_to
- Select which taxonomic level a taxonomic tree will go down to with
galah_down_to()
+atlas_taxonomy()
, which uses tidy evaluation like othergalah_
functions (#101, #120)
Pipe queries using galah_call
- Build data queries using piping syntax (i.e.,
|>
,%>%
) by first usinggalah_call()
, narrowing queries withgalah_
functions and finishing queries with anatlas_
function (#60, #120). - S3 methods are now implemented to functions to allow for piping (#40)
Minor improvements
- Improved error messages using {glue} and {rlang} (#117)
- Revamped syntax functions return output as tibbles (#110, #118)
- Pass vectors to
galah_filter
(#91, #92) - Cache valid fields for faster field look up (#73, #116)
- New vignettes for updated syntax (#104, #105), plus improvements to previous vignettes.
- Updated R Markdown-style documentation and added warnings for deprecated functions (#113, #121)
Bug fixes
v1.3.1
search_taxonomy()
renamed to ala_taxonomy()
- bug fix:
ala_taxonomy
no longer fails for nodes ranked asinformal
orunranked
(#86) - this function now returns a tree built using the
data.tree
package - change in function name required for greater consistency with other data-providing functions in
galah
Vignettes
v1.3.0
galah_config()
ala_config()
has been renamed togalah_config()
to improve internal
consistency (#68)
search_taxonomy()
search_taxonomy()
provides a means to search for taxonomic names and check
the results are 'correct' before proceeding to download data via
ala_occurrences()
,ala_species()
orala_counts()
(e.g., not ambiguous or
homonymous) (#64 #75)search_taxonomy()
returns information of author and authority of taxonomic
names (#79)search_taxonomy()
consistently orders column names, including in correct
taxonomic order by rank (#81)
Caching helper functions
find_cached_files()
lists all user cached files and stored metadata (#57)clear_cached_files()
removes previously cached files and stored metadata
(#71)ala_counts()
,ala_occurrences()
,ala_media()
andala_species()
now
haverefresh_cache
argument to remove previously cached files and replace with
the current query (#71)
Minor improvements
- Cache files are saved in RDS format, making query attributes easier to find,
including data DOI, search url (#55, #32, #28) ala_media()
caches media metadata ifgalah_config(caching = TRUE)
search_fields()
allows the user to pass aqid
as an argument (#59)- Users can now optionally skip filter and count validation checks to spatial
and biocache web services by settinggalah_config(run_checks = FALSE)
. This
helps users avoid slowing down data request download speeds when many requests
are made in quick succession viaselect_filters()
orala_occurrences()
(#61,
#80) ala_counts()
,select_columns()
andsearch_fields()
now usematch.arg
to approximate strings through fuzzy matching (#66)- Better handling of cache errors and improved error messages (#70)
Bug fixes
select_columns(group = 'assertions')
now sendsqa = includeall
to ALA web
service API to return all assertion columns (#48)ala_occurrences()
returns data DOI whenala_occurrences(mint_doi = TRUE)
and re-downloads data when called multiple times (#56)ala_occurrences()
no longer converts field names with all-CAPS to camelCase
(#62)
v1.2.0
Living Atlases
ala_config()
allows users to specify an international Atlas to download data
from (#21)
Minor improvements
ala_media()
includes the file path to the downloaded media in the
returned metadata (#22)- Data returned from
ala_occurrences()
contains thesearch_url
used to
download records; this takes the user to the website search page (#32) ala_species()
provides a more helpful error if no species are found (#39)- Data quality filters are created using the specific web service argument,
rather than constructing filters from the attributes (#37) select_taxa()
has an optionalall_ranks
argument to return intermediate
rank information (#35)
Bug fixes
- R > 4.0.0 is now required (#43, #45)
select_taxa()
behaves as expected when character strings of 32 or 36
characters are provided (#23)- Caching functionality for
ala_occurrences()
uses thecolumns
as expected
(#30) select_filters()
negates assertion filters when required, fixing the issue
of assertion values being ignored (#27)select_taxa()
no longer throws an error when queries of more than one term
have a differing number of columns in the return value (#41)ala_counts()
returns data.frame with consistent column classes when
agroup_by
parameter is called multiple times andala_config(caching = TRUE)
(#47)ala_
functions fail gracefully if a non-id character string is passed (#49)
v1.1.0
Downloading media
ala_media()
now takes the sameselect_
arguments as otherala_
functions (#18)- Filtering by media metadata e.g. licence type is possible (#19)
search_fields
now hasmedia
as atype
argument option- Performance improvement in download times (#13)
- Progress bar displayed for downloads when
verbose == TRUE
(#8) - All media download types are supported
select_ functions
select_locations
auto-detects the type of argument provided and so takes
a single argument,query
, in place ofsf
andwkt
(#17)select_taxa
auto-detects the type of argument provided and so takes a single
argument,query
, in place ofterm
andterm_type
(#16)
Minor improvements
v1.0.0
First version of galah, built on earlier functionality from the ALA4R package