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

I like! #1

Open
kjappelbaum opened this issue Aug 23, 2022 · 2 comments
Open

I like! #1

kjappelbaum opened this issue Aug 23, 2022 · 2 comments
Assignees

Comments

@kjappelbaum
Copy link

I feel it could be similar to checkcif, i.e. highlight potential issues for an expert reviewer (and required by journals).

I think one could check off many of the items on the JOSS reviewer checklist automatically.

Additionally, one might try:

  • Run the installation with the provided commands, afterward check that one can import the module
  • Check if there is a test suite (that is run automatically on GH actions, Travis, ...)
  • Check if one can create issues ;)

As you suggested, one might want to also add subject-specific checks. For instance, for ML

  • One can check if there is some link to a dataset on a repository
  • Check if there are model checkpoints

Quite domain specific would then be to check if the train/test set are indeed independent.

@kjappelbaum
Copy link
Author

Here's a tool that might already address some of the checkmarks https://github.com/fair-software/howfairis

@cthoyt cthoyt self-assigned this Oct 14, 2022
@cthoyt
Copy link
Owner

cthoyt commented Oct 14, 2022

I saw that. It doesn’t do what I want, and I don’t like how it does it. With this kind of stuff I would much rather rebuild it from scratch.

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

No branches or pull requests

2 participants