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

Add in the R/Y/G citation system #61

Merged
merged 3 commits into from
Apr 16, 2020
Merged

Add in the R/Y/G citation system #61

merged 3 commits into from
Apr 16, 2020

Conversation

Lnaden
Copy link
Collaborator

@Lnaden Lnaden commented Apr 16, 2020

Description

Updated the review process to be much more open and accepting with a system to have discussions through github issues

Added a Red / Yellow / Green (RYG, R/Y/G) system to most data types which are generated by people for "no publication," "has preprint or submitted," and "published," respectively. Auto generates based on YAML keys (and RCSB for structures)

Status

  • Ready to go

@Lnaden Lnaden merged commit 8d52448 into master Apr 16, 2020
@Lnaden Lnaden deleted the laundry_list branch April 16, 2020 19:44
@jchodera
Copy link
Contributor

Added a Red / Yellow / Green (RYG, R/Y/G) system to most data types which are generated by people for "no publication," "has preprint or submitted," and "published," respectively. Auto generates based on YAML keys (and RCSB for structures)

I...is this useful?

I mean, why not just add a link to the preprint and/or a link to the published paper DOI? Why introduce a totally unnecessary stoplight system that doesn't actually help people find information?

Also, a stoplight system tied to publication could mistakenly suggest that published papers are somehow more trustworthy than preprints, which is certainly not the case.

@jchodera
Copy link
Contributor

Also, many high quality structures are showing up with red stoplights, which is definitely not what we want.

@Lnaden
Copy link
Collaborator Author

Lnaden commented Apr 17, 2020

The RYG system is to indicate whether or not a datum has undergone an official, regulated, peer review process at a glance. We're trying to remain as neutral as we can on the mater and are simply accepting data, leaving mechanisms such as issues and project boards for the community and teams to have discussions on the data. If need be, we transfer the discussions to another public facing system if discussing through issues isn't suitable. As the reviews come in and consensus is reached from the community based on both usefulness and quality, we can take advantage of the rating system or some equivalent to indicate what the top data are.

We are going to be keeping an ear open for community feedback on the subject though, and if people do not like this system, we can work on a replacement.

@eriklindahl
Copy link

Red does not mean "bad", just that nobody has had a look at that particular entry yet. If one does not feel that indication is useful, the easy solution is of course to just ignore it and use all data :-)

However, in particular as we open up and allow anybody to submit anything, we need to at least be prepared for how to handle less-than-ideal submissions. An alternative could be to use "no color" instead of red to empasize that it hasn't been checked, not that it's considered bad.

I don't really believe in strict definitions for the quality system, but I prefer to think of it as

  1. Unclassified
  2. Enough extra information that I can at least try to assess the quality
  3. At least one other person has already done Desres Trajectories - And Javascript fixes #2 and thinks it might be good enough to be useful

For things like structures with a PDB ID and a preprint available from a trustworthy group, I don't think we need any motivation whatsoever to mark it as likely to be useful.

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.

3 participants