oda-hub / oda-bot

0 stars 0 forks source link

acknowledgements #27

Closed dsavchenko closed 10 months ago

dsavchenko commented 10 months ago

I will try to summarize my understanding

  1. Acknowledgements text will be defined in acknowledgements.md as proposed in this PR
  2. Maintainer name and email will be defined in mmoda.yaml. The logic of this spread between two files is such: *.md is about representation, mmoda.yaml is used for internal configs
  3. The list of authors from commits: I don't think we should show it in the acknowledgements field in frontend (or in oda_api response in the future), neither in addition to the citation defined in acknowledgements.md nor in the default placeholder. This list could be quite long. Probably, only maintainer may be shown in the default placeholder.
  4. Instead, we use this full list to send email notifications. But we should probably think of the way to unsubscribe.
dsavchenko commented 10 months ago

Keeping in mind nb2galaxy conversion, we will need to have citation info in a structured format (only doi or bibtex supported there). Therefore, we need to rethink once again, which file provides which info, to not split related things (this would be confusing for users)

Still, I prefer to provide an option for the free-text acknowledgements, and we can render bibtex à la galaxy in the future as default

volodymyrss commented 10 months ago

Keeping in mind nb2galaxy conversion, we will need to have citation info in a structured format (only doi or bibtex supported there). Therefore, we need to rethink once again, which file provides which info, to not split related things (this would be confusing for users)

Still, I prefer to provide an option for the free-text acknowledgements, and we can render bibtex à la galaxy in the future as default

Of course, acknowledgement is not the same thing as citation. The field in the frontend should combine both. Galaxy does not have acknowledgement I guess.

dsavchenko commented 10 months ago

As agreed, we will use CITATION.cff

dsavchenko commented 10 months ago

As agreed, we will use CITATION.cff

At least we can try to. But there are restrictions. First, there is no direct support for this format in gitlab (in contrast with github) (but at least it's an issue https://gitlab.com/gitlab-org/gitlab/-/issues/337368), so the created files won't be validated and visualized for the users in renkulab

There is a cli program to convert this format made in python, but it currently lacks support for preferred-citation and references -- features that are definitely important for scientific workflows. So we will either need to invent the wheel or contribute to that repo. Both are feasible, but may take time, and now we are looking for quick-and-dirty but still functional enough solution.

There is also a ruby library used by github, but I don't think we want to use ruby

volodymyrss commented 10 months ago

Let's just keep acknowledgement text it will be useful anyway.

cff we add later.

dsavchenko commented 10 months ago

So let's merge this one. I created an issue to not forget about citations etc.