Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update continuous and categorical sections of table in README #665

Merged
merged 10 commits into from
Sep 11, 2024

Conversation

Steph-Chong
Copy link
Collaborator

@Steph-Chong Steph-Chong commented Sep 10, 2024

Fixes #647 - using @nicholasloveday's suggestions

Reduces the length of the continuous and categorical sections.

I think it looked okay in GitHub on my fork and looked okay in readthedocs when I built it locally.

README.md Outdated Show resolved Hide resolved
@Steph-Chong

This comment was marked as resolved.

@Steph-Chong Steph-Chong changed the title Update continuous and categorical sections of table in README (Ready for review) Update continuous and categorical sections of table in README Sep 10, 2024
@Steph-Chong
Copy link
Collaborator Author

Steph-Chong commented Sep 10, 2024

I have now udpated this PR following offline feedback from Tennessee. I also took the opportunity to make one minor edit in each of the three paragraphs following the table.

My remaining questions are:

  1. Should the order of the two sentences immediately above the table be swapped? E.g., something along the lines of: "Click here for the full list of metrics, tools and statistical tests included in scores. Below is a curated selection:"

  2. Something about "17 binary contingency table (confusion matrix) metrics" looks slightly odd to me (but that might just be me). A part of me would like to instead say "17 x binary contingency table (confusion matrix) metrics" - but I am not sure if that is worse and/or potentially confusing?

@tennlee
Copy link
Collaborator

tennlee commented Sep 10, 2024

I have pushed this to 228, so it should render on readthedocs shortly

@tennlee
Copy link
Collaborator

tennlee commented Sep 10, 2024

Copy link
Collaborator

@nicholasloveday nicholasloveday left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me. Thanks for this update.

@Steph-Chong Steph-Chong changed the title (Ready for review) Update continuous and categorical sections of table in README Update continuous and categorical sections of table in README Sep 11, 2024
@tennlee tennlee merged commit 33bcd86 into nci:develop Sep 11, 2024
10 checks passed
@tennlee tennlee deleted the Update-README-table-of-metrics branch September 11, 2024 01:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Reviewing which metrics are mentioned in the README
3 participants