bug: Automatic column naming could be misleading #9
Comments
a-vester
added a commit
that referenced
this issue
Nov 3, 2022
BREAKING CHANGE: * ``get_scores_from_ratings()`` When input a ``pd.Series``, the name of the output series will now become ``ratings.name`` prefixed with "rtg_score". When input a ``pd.DataFrame``, the column names of the out frame will now become ``ratings.columns`` prefixed with "rtg_score_". * ``get_warf_from_ratings()`` When input a ``pd.Series``, the name of the output series will now become ``ratings.name`` prefixed with "warf". When input a ``pd.DataFrame``, the column names of the out frame will now become ``ratings.columns`` prefixed with "warf_". Closes #9
deepakparashar1987
pushed a commit
that referenced
this issue
Nov 8, 2022
refactor: Automatic column naming BREAKING CHANGE: * ``get_scores_from_ratings()`` When input a ``pd.Series``, the name of the output series will now become ``ratings.name`` prefixed with "rtg_score". When input a ``pd.DataFrame``, the column names of the out frame will now become ``ratings.columns`` prefixed with "rtg_score_". * ``get_warf_from_ratings()`` When input a ``pd.Series``, the name of the output series will now become ``ratings.name`` prefixed with "warf". When input a ``pd.DataFrame``, the column names of the out frame will now become ``ratings.columns`` prefixed with "warf_". Closes #9
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
When applying the functions
get_scores_from_ratings/get_scores_from_warf, the resulting series/dataframe column will have therating_providerattached to its name. This might be misleading.Example from the "Getting started" section of the docs:
Here, the column
rtg_score_SPis coming fromworst_rtg. However, this is not clear.Hence, it would be more appropriate to have the series/column name of the source to be suffixed to "rtg_score", i.e. the column name should be something like "rtg_score_worst_rtg".
The text was updated successfully, but these errors were encountered: