algorithm-archive icon indicating copy to clipboard operation
algorithm-archive copied to clipboard

Create Citation file to make it easier to cite from the AAA

Open stormofice opened this issue 4 years ago • 5 comments

Feature Request

Description

GitHub has recently introduced CITATION.cff files to help users correctly cite the contents of a repository. I think it could be a nice and simple way for people to cite contents of the AAA properly, if they wanted to.

For Algorithm Archive Developers

  • [ ] This feature can be added to the Master Overview (if it cannot be, explain why in a comment below -- lack of technical expertise, not relevant to the scope of this project, too ambitious)
  • [ ] There is a timeline for when this feature can be implemented
  • [ ] The feature has been added to the Master Overview
  • [ ] The feature has been implemented (Please link the PR)

stormofice avatar Aug 27 '21 22:08 stormofice

Oh, it has a zenodo link already. Nice! Yeah, I am in to this.

leios avatar Aug 28 '21 04:08 leios

Do we put all of the contributors on the CITATION.cff file? If so, maybe we want a script to take the existing contributors.md and convert it to a CITATION.cff file.

One issue here is that most people in that file did not use their actual name. In addition, there could be the case where a contributor does not want to be on the citation. I am also not sure what to do with ORCID stuff.

I was wondering if it would make more sense to do something like the Journal of Open Source Education (JOSE -- https://jose.theoj.org/, #373 ), as I think this will appear on google scholar and stuff for people who actually care about citation count and stuff. So far as I can see, the citation.cff file cannot be found (yet) on google scholar and such.

leios avatar Sep 04 '21 02:09 leios

Do we put all of the contributors on the CITATION.cff file? If so, maybe we want a script to take the existing contributors.md and convert it to a CITATION.cff file.

One issue here is that most people in that file did not use their actual name. In addition, there could be the case where a contributor does not want to be on the citation. I am also not sure what to do with ORCID stuff.

I think that unless some people actively want to see their full name online, which is probably not the majority, you probably should not put them in the CITATION.cff file. Also, providing a CITATION file and publishing in JOSE is not incompatible (or that would make the scientific publishing world even weirder than I thought). As such, I consider those two issues separate, and it could be a good time to reactivate the debate about publishing.

Amaras avatar Sep 04 '21 18:09 Amaras

I have a few more notes:

  1. The author list here could get kinda large. How do we deal with this? Schloss et. al. is obviously fine, but a lot of organizations have a collaboration that they go under, so we could just call the whole organization the "algorithm archivists" or something? I am not sure how those citations will work with google scholar, but maybe we should look into it?
  2. To be clear: I think that anyone who has contributed anything to the algorithm archive should be a candidate for the author list.
  3. I still don't know if this is actually integrated into google scholar / other citation metrics, which is why I brought up JOSE again. That would me a somewhat more formal (and technically peer reviewed) journal. Obviously, doing both is totally fine, I just wasn't sure when we should be considering JOSE. Maybe when we reconsider having a physically printed book?
  4. Is this a replacement for the contributors.md file?

leios avatar Sep 15 '21 17:09 leios

Note : If we end up using CITATION.cff, and because this is a research project, then we should be citing them somewhere as well. Since it's a research software and have the citing button.

ShadowMitia avatar Nov 05 '21 18:11 ShadowMitia