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

Feature Request/Idea: Add CSTR to Related Publication ID Type list #8838

Closed
jggautier opened this issue Jul 12, 2022 · 8 comments · Fixed by #9064
Closed

Feature Request/Idea: Add CSTR to Related Publication ID Type list #8838

jggautier opened this issue Jul 12, 2022 · 8 comments · Fixed by #9064

Comments

@jggautier
Copy link
Contributor

jggautier commented Jul 12, 2022

Overview of the Feature Request

What kind of user is the feature intended for?
(Example users roles: API User, Curator, Depositor, Guest, Superuser, Sysadmin)
Curator, Depositor

What inspired the request?
Xiaolei Xia from the Computer Network Information Center, the Chinese Academy of Sciences, emailed Dataverse support to request that the resource identifier called CSRT (https://www.cstr.cn/search/specification) be added to the list of ID types in the Relation Publication metadata field's ID Type field. That way depositors publishing datasets in Dataverse repositories can add a related publication that as this type of identifier. They would like it added by the end of August.

What existing behavior do you want changed?
Add CSTR to the list of ID types in the Related Publication metadata field's ID Type field. The CSTR ID will also have to be included in several metadata exports that already include what depositors enter in the ID Type and ID Number fields: DDI, DC Terms, and OpenAIRE.

Any related open or closed issues to this feature request?
None that I can think of.

@xiaya2309
Copy link

Hello!

Thank @jggautier for giving us this chance to apply for adding the CSTR identifier in the Harvard Dataverse Related Publication ID Type list and created this request.

Please allow us to briefly introduce the CSTR identifier.

CSTR is an identifier for Common Science and Technology Resources, to provide persistent identification services for the positioning, traceability, citation, statistics and evaluation of science and technology resources. At present, CSTR has provided identification services for more than 55 data repositories and science data centers, including Science Data Bank.We helped the journal to assign CSTR helping them share their paper more easily.

The publication example as follows
http://www.jfdc.cnic.cn/EN/10.11871/jfdc.issn.2096-742X.2022.03.002

In the meantime, I have provided an example of a published pdf of a journal paper. You can find the CSTR identifier assigned to this article in the top left corner of the first page.

We hope this example will help you to better understand the CSTR.

Implementation of Element-Wise Operator in TensorFlow Framework Based on OpenCL.pdf

@jggautier jggautier changed the title Feature Request/Idea: Add CSTR to Harvard Dataverse Related Publication ID Type list Feature Request/Idea: Add CSTR to Related Publication ID Type list Jul 13, 2022
@xiaya2309
Copy link

We would like to add a few more points about the current progress of the CSTR.

1. How many CSTR IDs have been created? Has the rate of creation increased?

The CSTR identifier is currently in high growth and the number of users is increasing rapidly, with over 420 papers and 17,010 preprint articles already assigned the CSTR identifier.
Most of these articles are historical articles from various publishers and we will subsequently assign CSTR marks to them according to the actual frequency of publication by the publishers.
The current visibility of the CSTR identifier is not high, resulting in no current enquiries from existing users of the Dataverse software. However, as the number of CSTR users increases, we are confident that we will have requests from users in the future.

2. We'll also have to figure out how people would and should add CSTR IDs in the related publication fields and how those IDs would be added to the metadata exports.

CSTRs are used in the same way as DOIs. When an article is published, the publishing organization assigns a CSTR to that article.

3. writing and testing the code needed to add the CSTR IDs to the list and include those IDs in the metadata exports

We finished writing the associated code by referring to ArXiv.

@jggautier
Copy link
Contributor Author

jggautier commented Aug 11, 2022

Thanks for submitting the pull request at #8913. In our emails (https://help.hmdc.harvard.edu/Ticket/Display.html?id=319451) you asked about next steps and I suggested we continue the conversation in this GitHub issue.

Also thanks for replying to what you quoted in your comment above. I should clarify my second point:

We'll also have to figure out how people would and should add CSTR IDs in the related publication fields and how those IDs would be added to the metadata exports.

I meant how people depositing datasets, including those who aren't data management professionals, would and should enter CSTR IDs. But I see you in the edited citation.tsv file that you added the string "CSTR" to the ID Type field, and based on the CSTR ID I see at the top of the example paper you provided (http://www.jfdc.cnic.cn/EN/10.11871/jfdc.issn.2096-742X.2022.03.002), the "ID Number" would be 32002.14.jfdc.CN10-1649/TP.2022.03.002. So it seems like people would enter the fields like:

Screen Shot 2022-08-11 at 11 14 23 AM

Do CSTR IDs have a URL form, e.g. how DOI:10.11871/jfdc.issn.2096-742X.2022.03.002 has the URL form https://doi.org/10.11871/jfdc.issn.2096-742X.2022.03.002? If so, following how the Related Publication field works now, the CSTR ID's URL form is what depositors should enter in that URL field.

I can see from the code that you've edited the TSV file to add CSTR to the bottom of the ID Type list. The list is alphabetically ordered. Whether that's better than other ways the list can be arranged (like by most to least used) is an interesting research question, but for now I think it should remain alphabetically ordered. All other ID Types are all lowercase (like arxiv and doi), so I think that convention should be maintained for now (and maybe revisited later). Would you be able to:

  • make sure CSTR appears all lowercase
  • make sure cstr appears between bibcode and doi

Another next step I can speak on is to have have certain parts of the Dataverse Guides updated. Some tips and technical info about documentation is at https://guides.dataverse.org/en/latest/developers/documentation.html. However, I can't think of any text in the Guides that will need to be changed in this case.

My colleagues who do the product management, code review and code testing work will join with more information about those parts of the process.

@jggautier
Copy link
Contributor Author

Hi @xiaya2309. I saw that you changed CSTR to all lowercase and moved it so that it appears between bibcode and doi, so that the list remains in alphabetical order. Thanks!

@xiaya2309
Copy link

Great! @jggautier Apart from the resloved URL of the CSTR, is there anything else we should provide to push adding CSTR to Related Publication ID Type list?

We also took a look at the Dataverse Guides you mentioned earlier, and referring to the way the Arxiv identifiers are displayed, it's the same idea as yours, and we don't think there's anything that needs to be changed.

At the moment we would like CSTR identifier to be displayed in the Related Publication ID Type list on the page (or registration API?) and the user can just fill it in when submitting data.

@jggautier
Copy link
Contributor Author

@xiaya2309 there's discussion with @cheneyfeng3 in the pull request at #8913 about next steps - resolving a merge conflict and a design question regarding the addition of another ID Type - which you're probably already seeing but I thought I'd try to acknowledge all of the questions here that I can.

Please feel free to continue the discussion there.

@xiaya2309
Copy link

Do CSTR IDs have a URL form, e.g. how DOI:10.11871/jfdc.issn.2096-742X.2022.03.002 has the URL form
We now have our resolution address https://cstr.cn/
You can use it in the same way as DOI.
For example: https://cstr.cn/32002.14.jfdc.CN10-1649/TP.2022.03.002
or https://cstr.cn/CSTR:32002.14.jfdc.CN10-1649/TP.2022.03.002

@jggautier
Copy link
Contributor Author

Thanks for the update! So people can enter the URL form in the URL field. And these IDs can be included in any future effort to automatically turn the IDs that depositors enter into clickable URLs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment