carat.util.example_beats_file¶

carat.util.example_beats_file(num_file=None)[source]¶

Get the path to an included example file of beats annotations.

Parameters:	num_file : int Number to select among the example files available.
Returns:	filename : str Path to the beats annotations example file included with `carat`.

Examples

>>> # Load beats and downbeats from the example audio file number 1
>>> beats, b_labs = carat.load_beats(carat.util.example_beats_file(num_file=1))
>>> downbeats, d_labs = carat.load_downbeats(carat.util.example_beats_file(num_file=1))