In the current version of galah, functions that manipulated or built queries were identified with a select_ prefix (i.e., select_taxa, select_filters, select_locations). With the changes to make syntax more consistent with dplyr filter, select and group_by (#101 ), this makes the syntax of select_taxa an outlier because it does not select columns (which is now what galah_select does).
After discussion, we decided that select_taxa is really a search function and should be renamed search_taxa, consistent with the existing search_fields function. Expected output of search_ functions will be made consistent as well.
Discussion also identified that the difference between search_ functions and find_ functions is ambiguous to the user, but most find_ functions return a data.frame of possible values. However, not all find_ functions accept a blank argument (e.g., find_field_values and find_profile_attributes). To remedy this inconsistent syntax to match their expected behaviour, functions that accept a blank argument and return a data.frame of possible values will be prefixed by show_all_:
In the current version of galah, functions that manipulated or built queries were identified with a
select_
prefix (i.e.,select_taxa
,select_filters
,select_locations
). With the changes to make syntax more consistent with dplyrfilter
,select
andgroup_by
(#101 ), this makes the syntax ofselect_taxa
an outlier because it does not select columns (which is now whatgalah_select
does).After discussion, we decided that
select_taxa
is really a search function and should be renamedsearch_taxa
, consistent with the existingsearch_fields
function. Expected output ofsearch_
functions will be made consistent as well.Discussion also identified that the difference between
search_
functions andfind_
functions is ambiguous to the user, but mostfind_
functions return a data.frame of possible values. However, not allfind_
functions accept a blank argument (e.g.,find_field_values
andfind_profile_attributes
). To remedy this inconsistent syntax to match their expected behaviour, functions that accept a blank argument and return a data.frame of possible values will be prefixed byshow_all_
: