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 support for multiple curators to be recorded #59

Open
gaurav opened this issue May 8, 2018 · 2 comments
Open

Add support for multiple curators to be recorded #59

gaurav opened this issue May 8, 2018 · 2 comments
Labels
difficulty: moderate Should take 3-5 days to close programming only No discussion necessary; just pure programming needed

Comments

@gaurav
Copy link
Member

gaurav commented May 8, 2018

Since ORCIDs are the best way to track scholarly contributions, we should record the ORCIDs for curators.

This issue used to cover authenticating using ORCID's Public API. However, the main benefit for signing in using ORCID is just to confirm that contributor's ORCID, which seems unnecessary. Instead, we should:

  1. Ask curators to authenticate with Github (Allow PHYX files to be directly uploaded to the Clade Ontology in Github #29).
  2. On their first login, we ask curators for their ORCID and record that in a JSON file in Github repository that stores curated PHYX files.
  3. When viewing a PHYX file from the curated repository, we prepare a list of contributors by getting a list of all Github users who contributed to that file and then looking up their ORCID IDs from the JSON file. While we'll miss contributors who made changes directly through Github, we can always modify the JSON file to include them.
@gaurav gaurav changed the title Allow curators to sign in using ORCID's Public API Record ORCIDs for curators and record them in Github May 29, 2018
@gaurav
Copy link
Member Author

gaurav commented May 29, 2018

In retrospect, this issue was overly complicated and also unnecessary -- authenticating with ORCID doesn't give us any additional benefits, but authenticating with Github would allow us to create and update files directly from the Curation Tool (as per #29). I updated this issue to reflect this.

gaurav added a commit that referenced this issue Jun 22, 2018
This allows each phyloreference to be in one of the states laid out in #25. Changes in state for each phyloreference are recorded along with a timestamp, allowing the previous history of the phyloreference to be documented. In the future, this could be extended to archive previous versions of the phyloreference or to identify who changed its state (#59). Since this pull request requires new prefixes in the PHYX file, I've also included a fix for #46 so that we include a copy of the context we need in this repository. I've incorporated Brochu 2003 as an example for demonstrating phyloreference statuses.
gaurav added a commit that referenced this issue Jan 29, 2019
This allows each phyloreference to be in one of the states laid out in #25. Changes in state for each phyloreference are recorded along with a timestamp, allowing the previous history of the phyloreference to be documented. In the future, this could be extended to archive previous versions of the phyloreference or to identify who changed its state (#59). Since this pull request requires new prefixes in the PHYX file, I've also included a fix for #46 so that we include a copy of the context we need in this repository. I've incorporated Brochu 2003 as an example for demonstrating phyloreference statuses.
@gaurav gaurav added difficulty: moderate Should take 3-5 days to close difficulty: hard Will take a while to close (>5 days) programming only No discussion necessary; just pure programming needed and removed difficulty: moderate Should take 3-5 days to close labels Aug 9, 2019
@gaurav gaurav added this to the Improve curator workflow milestone Nov 15, 2019
@gaurav
Copy link
Member Author

gaurav commented Dec 14, 2021

Klados currently records:

  • A curator name (in the curator field in the top-level Phyx object)
  • A curator e-mail address (in the curatorEmail field)
  • A curator ORCID (in the curatorORCID field)

None of these fields are currently included in the Phyx specification, which instead provides a top-level citation field that is intended to be a citation to the ORCID file itself.

Proposed changes

  1. Remove these three individual fields and replace them with a single Citation that is described as the "Citation to this Phyx file".
  2. Add support for including author e-mail addresses and ORCIDs to the Citation object.

@gaurav gaurav added difficulty: moderate Should take 3-5 days to close and removed difficulty: hard Will take a while to close (>5 days) labels Dec 14, 2021
@gaurav gaurav changed the title Record ORCIDs for curators and record them in Github Add support for multiple curators to be recorded Aug 24, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
difficulty: moderate Should take 3-5 days to close programming only No discussion necessary; just pure programming needed
Projects
None yet
Development

No branches or pull requests

1 participant