maad.util.xc_query

maad.util.xc_query(searchTerms, max_nb_files=None, format_time=False, format_date=False, random_seed=1979, verbose=False)

Query metadata from Xeno-Canto website depending on the search terms. The audio recordings metadata are grouped and stored in a dataframe.

Parameters:

searchTermslist

list of search terms to perform the query The main seach terms are : - grp : birds - gen : genus - ssp : subspecies - en : english name - q : quality - cnt : country - len : length - area : continent (europe, africa, america, asia) see more here : https://www.xeno-canto.org/help/search

max_nb_files: integer, optional

Maximum number of audio files requested. The default is None

format_timeboolean, optional

Time in Xeno-Canto is not always present neither correctly formated. If true, time will be correctly formated to be processed as DateTime format. When formating is not possible, the row is dropped. The default is False

format_dateboolean, optional

Date in Xeno-Canto is not always present neither correctly formated. If true, rows with uncorrect format of date are dropped.

random_seedinteger, optional

Fix the random seed in order to get the same result every time the function is called

verboseboolean, optional

Print messages during the execution of the function. The default is False.

Returns:

df_datasetpandas DataFrame

Dataframe containing all the recordings metadata matching search terms