clamsproject / clams-python

CLAMS SDK for python
http://sdk.clams.ai/
Apache License 2.0
4 stars 1 forks source link

"citation" in appmetadata #81

Open keighrim opened 3 years ago

keighrim commented 3 years ago

Usually when wrapping an existing academic research software, we often find the original software has some citation. We can add citation field in the app metadata to store such information. For example;

{ 
  "name": "some-famous-research-tool", 
  ...
  "citation": 
  {
    "@type: "http://www.bibtex.org/", 
    "@value": "@inproceedings{NIPS2017_3f5ee243,\n author = {Vaswani, Ashish and Shazeer, Noam and Parmar, Niki and Uszkoreit, Jakob and Jones, Llion and Gomez, Aidan N and Kaiser, \L ukasz and Polosukhin, Illia},\n booktitle = {Advances in Neural Information Processing Systems},\n editor = {I. Guyon and U. V. Luxburg and S. Bengio and H. Wallach and R. Fergus and S. Vishwanathan and R. Garnett},\n pages = {},\n publisher = {Curran Associates, Inc.},\n title = {Attention is All you Need},\n url = {https://proceedings.neurips.cc/paper/2017/file/3f5ee243547dee91fbd053c1c4a845aa-Paper.pdf},\n volume = {30},\n year = {2017}\n}"
}

Or more simply,

{ 
  "name": "some-famous-research-tool", 
  ...
  "citation": 
  {
    "@type: "https://arxiv.org/help/faq/references", 
    "@value": "arXiv:1706.03762"
}

or other citation schemes can be used (e.g. DOI).

(got this idea from Galaxy project https://docs.galaxyproject.org/en/latest/dev/schema.html#tool-citations)

marcverhagen commented 3 years ago

Probably useful yes. But we could also have that as part of the full description.