This is an evolving roadmap, basically me trying to organize in one place what needs to get done. Issues are roughly in the order they will be fixed. Will make a project board to go with this too

• DOC: Add 'getting started' tutorial #68
• ENH: Remove signal.spectrogram, replace with vocalpy.spectrogram #88
  • in progress in https://github.com/vocalpy/vocalpy/tree/add-spectrogram-function-fix-%2388
• ENH: Add examples module with example function, use pooch, adapt from librosa #33
  • bumping this towards the top because we need it for examples for everything else, e.g. in docstrings, to show spectrograms, and so on and so forth
• have clear segmenting workflow for Segments and Boxes, as discussed in ENH: Add Segments and Boxes class, have vocalpy.segment functions return them #127
  • CLN/ENH: Decouple Segments from Sound #154
  • ENH: Add segment method to Sound #150
  • CLN: Remove path attribute from Sound #162
• have clear feature extraction workflows (that depend in part on having clear segmenting workflow)
  • ENH: Feature module + API #91
  • ENH: Implement FeatureExtractor #94
  • CLN: Add tests for feature.biosound #159
  • BUG: feature.soundsig.predefined_acoustic_features should return vocalpy.Features #145
  • BUG/CLN: FeatureExtractor should not be making Features instances #146
  • CLN: Add tests for feature.biosound #159
  • TST: Add tests for FeatureExtractor #161
  • CLN: Have FeatureExtractor only take Sound or list of Sounds #163
• vignettes
  • DOC: vignette of using vocalpy.Segmenter #14
  • DOC: vignette of using vocalpy.SpectrogramMaker #15
  • DOC: vignette on "using VocalPy with UMAP + HDBSCAN" #166
  • DOC: vignette on "using vocalpy with scikit-learn" #165
• ENH: have functions accept vocalpy.Audio, return vocalpy.Spectrogram, vocalpy.LineSegment, etc. #48
  • I checked this some in ENH: Rename vocalpy.segment.audio_amplitude -> energy, fix #62 #63, we are doing it in places but there are still functions we need to change In think
• ENH: Compute IR metrics per boundary type #67
• ENH: Add additional segmenting algorithms (meta issue) #55
• ENH: Add decorators: takes_audio, returns_spect, returns_seq, returns_box #64
• ENH: Add feature module #3
• ENH: Feature module + API #91
• ENH/META: add modules with models of acoustic communication #47