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 per-phyloreference curator information to Phyx and Klados #242

Open
gaurav opened this issue Mar 31, 2022 · 2 comments
Open

Add per-phyloreference curator information to Phyx and Klados #242

gaurav opened this issue Mar 31, 2022 · 2 comments
Assignees
Milestone

Comments

@gaurav
Copy link
Member

gaurav commented Mar 31, 2022

At the moment, we record provenance per-file, including curator name, e-mail address and ORCID. I proposed in #59 (comment) that we should replace this with a citation so we can record multiple curators. We had a larger discussion about provenance today, where we decided that at a minimum we should also record the creation time and last-modified time.

However, thinking about this more broadly, we should look at what other organizations like the GO consortium (or their tools like Noctua, etc.) do and follow their lead -- for example, should we record provenance for each individual phyloreference, or is doing it for the whole file okay? Should we bring back the system of giving phyloreferences states (e.g. "draft", "final draft", "tested", "published") and recording when the state changed and by whom? Should we include a logging system so that we can track all the changes being made by anybody, should those changes be stored in the Phyx file itself, or should we let an external version control system take precedence for dealing with that?

While we have a primary goal of ensuring that Klados is a good curation tool, there is an important secondary goal here -- generating and testing provenance information that we will later incorporate into the Clade Ontology.

I'll do some research into what other organizations and ontologies do, and report back.

@gaurav gaurav added this to the Klados v1.0 milestone Mar 31, 2022
@gaurav gaurav self-assigned this Mar 31, 2022
@gaurav gaurav added the discussion needed Discussion is needed before this issue can be closed label Nov 2, 2022
@gaurav gaurav changed the title Figure out how to handle curator provenance Expose source field in Klados Nov 2, 2022
@gaurav
Copy link
Member Author

gaurav commented Nov 2, 2022

We have two options:

  1. Leave in the current fields, but have them stored in the Phyx file in the source field.
  2. Replace the curator information with a source field.

However, we do want to have curator information at the per-phyloreference level (similar to how we have per-term attribution on an ontology). This could be name + identifier or only identifier, so e-mail is probably unnecessary (double-check this with Jim).

So, next steps:

  • Propose changes to Phyx to include basic curator information at the phyloreference level (this would bump it to v1.1.0). Review there and make the change there first.
  • Update Klados to include per-phyloreference curation level.

Goal: stay consistent with user stories in user stories.

@gaurav gaurav removed the discussion needed Discussion is needed before this issue can be closed label Nov 2, 2022
@gaurav gaurav changed the title Expose source field in Klados Add per-phyloreference curator information to Phyx and Klados Nov 2, 2022
@gaurav
Copy link
Member Author

gaurav commented Nov 15, 2022

Now opened as an issue on phyx.js as phyloref/phyx.js#119

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

1 participant