tidyverts / feasts

Feature Extraction And Statistics for Time Series
https://feasts.tidyverts.org/
295 stars 23 forks source link

function naming #57

Closed earowang closed 5 years ago

earowang commented 5 years ago

https://github.com/tidyverts/feasts/blob/13aff9095b9369e1fcded4b5e45c4ac04514ef32/R/hctsa_features.R#L53

A large chunk of functions could be renamed to take advantage of autocompletions and suggesting similar functionalities.

If ... not used, can we remove it then?

mitchelloharawild commented 5 years ago

Only minor changes have been made from what is available in tsfeatures. What naming convention do you suggest for these features?

... cannot be removed because the summarise() call will pass all inputs to all functions. It can be removed if summarise() is replaced with map(), however then no arguments could be passed via ... (now that I think of it, passing inputs via ... is likely a bad idea anyway.

earowang commented 5 years ago

Roughly:

earowang commented 5 years ago

Can you briefly update _pkgdown.yml to split functions into sections? It'd be easier to see the common patterns for function name.

earowang commented 5 years ago

A shortcut for computing all features available in the package: features_available()

mitchelloharawild commented 5 years ago

Regarding features_available(), would it be better to use features_feasts()? That way feasts.tsfresh could use features_tsfresh().

earowang commented 5 years ago

sounds good