Open jmoo2880 opened 4 months ago
Also, the changelogs will be more extensive and clearer about the breaking changes for users + new naming conventions with old short_names and names essentially swapping places.
@anniegbryant can you do a quick test?
I tried the new catch22_all function with my workflow. The change in the dictionary/dataframe key from 'values' (old version) to 'value' (new version) breaks my code. Otherwise, it works fine.
Modifying the original changes proposed by @anniegbryant in PR https://github.com/DynamicsAndNeuralSystems/pycatch22/pull/21, this PR updates the catch22 output to a DataFrame and marks a transition away from long (HCTSA) feature names toward what has previously been called "short" feature names, as default, i.e.,
mode_5
instead ofDN_HistogramMode_5
, etc.Breaking Changes:
Since these modifications will introduce breaking changes for the existing user base, this PR will constitute a new major version release (catch22
v1.0.0
), with docs + README updated to reflect the new output format. Users will need to be made aware of the new output via clear documentation and a migration guide in the changelogs to avoid confusion.Major changes
short_names
as an optional parameter in thecatch22_all()
function. Three columns will now be returned as standard:feature
,hctsa_name
andvalue
. That is,catch22_all()
now accepts only two arguments:< = v0.4.5
catch22features_short
are now calledfeatures
(orfeature
in the output DataFrame).< = v0.4.5
catch22feature
is nowfeatures_hctsa
(orhctsa_name
in the output DataFrame).catch22
results are now returned as a pandasDataFrame
instead of adict
for improved readability:print the first feature name
print(df.feature[0])
print the first feature value
print(df.value[0])
print the first feature HCTSA (long) name
print(df.hctsa_name[0])