New function to supersede Summarize function to summarise results -- with more flexibilitythan previous utility function
#1457
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
… that function (without disturbing the original summarize function, upon which many analayis script rely.)
…ummarize` to `summarise`
…se new function to avoid duplication
mnjowe
approved these changes
Oct 17, 2024
matt-graham
requested changes
Oct 18, 2024
src/tlo/analysis/utils.py
Outdated
Comment on lines
321
to
325
| :Param: results: The pd.DataFame of results. | ||
| :Param: central_measure: The name of the central measure to use - either 'mean' or 'median'. | ||
| :Param: width_of_range: The width of the range to compute the statistics (e.g. 0.95 for the 95% interval). | ||
| :Param: collapse_columns: Whether to simplify the columnar index if there is only one run (cannot be done otherwise) | ||
| :Param: only_central: Whether to only report the central value (dropping the range). |
There was a problem hiding this comment.
Suggested change
| :Param: results: The pd.DataFame of results. | |
| :Param: central_measure: The name of the central measure to use - either 'mean' or 'median'. | |
| :Param: width_of_range: The width of the range to compute the statistics (e.g. 0.95 for the 95% interval). | |
| :Param: collapse_columns: Whether to simplify the columnar index if there is only one run (cannot be done otherwise) | |
| :Param: only_central: Whether to only report the central value (dropping the range). | |
| :param results: The dataframe of results to compute summary statistics of. | |
| :param central_measure: The name of the central measure to use - either 'mean' or 'median'. | |
| :param width_of_range: The width of the range to compute the statistics (e.g. 0.95 for the 95% interval). | |
| :param collapse_columns: Whether to simplify the columnar index if there is only one run (cannot be done otherwise). | |
| :param only_central: Whether to only report the central value (dropping the range). | |
| :return: A dataframe with computed summary statistics. |
Small update to fix parameter directive syntax in docstring and adding return information.
There was a problem hiding this comment.
Needs lowercase p in param
There was a problem hiding this comment.
it is now a lowercase piece (I believe). This view seems to be out-dated.
Co-authored-by: Emmanuel Mnjowe <32415622+mnjowe@users.noreply.github.com>
Co-authored-by: Emmanuel Mnjowe <32415622+mnjowe@users.noreply.github.com>
Co-authored-by: Matt Graham <matthew.m.graham@gmail.com>
Co-authored-by: Matt Graham <matthew.m.graham@gmail.com>
tbhallett
changed the title
Summarise function to summarise results -- with more flexibilitythan previous utility functionSummarize function to summarise results -- with more flexibilitythan previous utility function
tamuri
approved these changes
Dec 13, 2024
matt-graham
approved these changes
Dec 13, 2024
There was a problem hiding this comment.
Thanks @tbhallett for the updates, this looks all good to me now!
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #1420