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

Feature-list-codecheckers #52

Merged

Conversation

angelina-momin
Copy link
Collaborator

@angelina-momin angelina-momin commented Aug 19, 2024

Solves issue #71
Related codecheck repo PR #90 and PR #97

The render_register function now creates a list of codecheckers as shown in the image below.
The codechecker name links to the codecheck website with all their codechecks.
The orcid ID links to their orcid pages.
The "JSON" links to the index.json file

Changes made:

  • Bumped version to 0.4.0
  • Move all config settings from register.R to a new inst/extdata/config.R file.
  • Created functions render_table_codecheckers for html and json files which are now called in render_register function
  • Added new template file for non register tables like the codecheckers table
  • Move all templates to inst/extdata/templates folder in this repo
  • Update the Rmarkdown files for the new functions

image

@angelina-momin angelina-momin marked this pull request as ready for review August 19, 2024 16:10
@angelina-momin
Copy link
Collaborator Author

@nuest just realized there is a discrepancy between the actual number of codechecks and the number of codechecks written on this page. This has to do with the fact that for some codechecks there is more than one author hence those codechecks are counted more than once. The total no. of codechecks as shown above is = sum of entries in the "no.of codechecks" column but the "no. of codechecks" column does not account for this double counting.

Should I change the subtitle to show total codechecks without double count and leave the no. of codechecks column as is? A bit confusing for a user if they add up the "no. of codechecks" and see the numbers dont match but the best solution I could think of. Possibly adding a small text stating that some codechecks have multiple authors?

@angelina-momin angelina-momin marked this pull request as draft August 19, 2024 16:23
@nuest
Copy link
Member

nuest commented Aug 19, 2024

Yes, change the number to checks without double count and please do add a short info about the reason for the discrepancy (though I don't think readers will take time to do the math ;-) ).

@angelina-momin
Copy link
Collaborator Author

angelina-momin commented Aug 20, 2024

@nuest let me know what you think of this. I'll also open this PR for review again and merge once you're good with it.

I already incorporated changes based on your comments in the previous PR.

image

@angelina-momin angelina-momin requested a review from nuest August 20, 2024 11:23
@angelina-momin angelina-momin marked this pull request as ready for review August 20, 2024 11:23
@nuest
Copy link
Member

nuest commented Aug 20, 2024

LGTM!

Good to see he tests are back in line, too.

@angelina-momin angelina-momin merged commit 95bf093 into codecheckers:master Aug 20, 2024
3 of 4 checks passed
@angelina-momin angelina-momin deleted the feature-list-codecheckers branch August 20, 2024 15:24
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.

2 participants