Currently, the readme and plot therein look to me like they demo the package. However, they do not show examples of setting the minimum window width w, nor do they demo the peakheights function.
I suggest:
a) All functions are shown in the readme, perhaps in a complete list, or that
b) the readme is made more barebones, and that users are referred to the documentation for fuller examples, which should include examples using peakheight and w?
Or some combination of the two:
"The filtering functions are seen in the table below, and full examples can be found in the docs"
Currently, the readme and plot therein look to me like they demo the package. However, they do not show examples of setting the minimum window width
w, nor do they demo thepeakheightsfunction.I suggest: a) All functions are shown in the readme, perhaps in a complete list, or that b) the readme is made more barebones, and that users are referred to the documentation for fuller examples, which should include examples using
peakheightandw?Or some combination of the two: "The filtering functions are seen in the table below, and full examples can be found in the docs"