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

evaluate addition of referencePublication field #277

Closed
mbjones opened this issue Sep 9, 2017 · 4 comments
Closed

evaluate addition of referencePublication field #277

mbjones opened this issue Sep 9, 2017 · 4 comments

Comments

@mbjones
Copy link
Contributor

@mbjones mbjones commented Sep 9, 2017

Moving discussion on the need for a referencePublication field to its own ticket (it was raised by @cboettig in #259).

From #259, @cboettig writes:

I still think this is an important issue, but difficult to implement satisfactorily because the whole idea is more of a practical hack than a technically precise idea. We struggled with this recently in codeMeta, and settled on a user's suggestion of referencePublication, codemeta/codemeta#144.

In Dryad, the concept is well-defined and clearly advertised on every data page: "Please cite the following publication as well as the dataset", since all Dryad datasets must be associated with a unique publication. It's unclear how to define this connection in EML.

In general, it seems this concept is a hack, best summarized as "please cite the following paper".

While there may be support for this proposal, it raises issues:

  • the field is redundant with the citation info in eml-resource, and so it would be ambiguous as to how to resolve conflicts between the metadata in the document (e.g., list of creators, title, packageId), and what is found in the referencePublication field. What if the order of authors are different, or the title differs? Which is the truly recommended citation?
    • right now, recommended best practice is to construct citations from the EML metadata, using the format:

Creator(s). pubDate. Title. Publisher. packageId.

  • maybe this would be considered an additional reference that should be cited, in addition to the data set. This seems to be Dryad's practice.

If this were desired, I would consider an implementation such as:

<xs:element name="referencePublication" type="cit:CitationType" minOccurs="0" maxOccurs="unbounded">
  <xs:annotation>
    <xs:appinfo>
       <doc:tooltip>Reference Publication</doc:tooltip>
       <doc:summary>A citation to an additional publication that serves as an important reference for a dataset.</doc:summary>
       <doc:description>AA citation to an additional publication that serves as an important reference for a dataset. People using this dataset should generally cite the dataset itself (using the creator, pubDate, title, publisher, and packageId fields), and consider providing an additional citation to the Reference Publication.
       </doc:description>
    </xs:appinfo>
  </xs:annotation>
</xs:element>
@mbjones mbjones added this to the EML2.2.0 milestone Sep 9, 2017
@mbjones mbjones added this to High priority in EML 2.2.0 Release Sep 9, 2017
@mbjones mbjones added the next label Oct 30, 2017
@mobb

This comment has been minimized.

Copy link
Contributor

@mobb mobb commented Feb 20, 2018

referencePublication would work, if it’s intended to be used like ‘reference implementation’, i.e., the paper illustrates the usage of this dataset.

For data papers, this would lead someone to the research paper that accompanied the dataset (if they reached the dataset by some pathway that did not include the paper) -- which is good - they are cases where they should be cited together.

But I think it is too strong a statement to say that users should “consider citing the paper” too. I can see plenty of cases where a reference publication are not be as tightly coupled as a research paper + data paper. ;

The example has wording for both (doc:summary, doc:description)

<xs:element name="referencePublication" type="cit:CitationType" minOccurs="0" maxOccurs="unbounded">
  <xs:annotation>
    <xs:appinfo>
       <doc:tooltip>Reference Publication</doc:tooltip>
       <doc:summary>A citation to an additional publication that serves as an important reference for a dataset, and illustrates its use.</doc:summary>
       <doc:description>People using this dataset should generally cite the dataset itself (using the creator, pubDate, title, publisher, and packageId fields), but should be aware of this Reference Publication, as it may also be relevant to their work.
       </doc:description>
    </xs:appinfo>
  </xs:annotation>
</xs:element>

@mobb

This comment has been minimized.

Copy link
Contributor

@mobb mobb commented Feb 20, 2018

related to #288

@mbjones mbjones added in progress and removed needs-review next labels Apr 25, 2018
@mbjones mbjones closed this Apr 25, 2018
@mbjones mbjones removed the in progress label Apr 25, 2018
mbjones added a commit that referenced this issue Apr 25, 2018
These include a new ability to use Bibtex citation format both within
the `citation` element, and within a new `bibtex` element, to create
lists of refs using these in a literatureCited element (#300), as well
as in usageCitation (#259), and referencePublication (#277) elements.
All of this helps support data papers (#269), for which pandoc-style
citation keys can be used to cite these references in the text of
Markdown blocks in the EML document.  Added these features as
demonstrations in the eml-data-paper.xml sample document.
@mbjones

This comment has been minimized.

Copy link
Contributor Author

@mbjones mbjones commented Apr 26, 2018

See schema for final wording in sha 3beb10b.

@mbjones

This comment has been minimized.

Copy link
Contributor Author

@mbjones mbjones commented Apr 30, 2018

Reopened to find a better name for the field that isn't so easily confused with literatureCited.

  • canonicalPublication
  • publicationOfRecord
  • authoritativePublication
@mbjones mbjones reopened this Apr 30, 2018
@mbjones mbjones closed this Nov 21, 2018
@mbjones mbjones removed the needs-review label Nov 21, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
EML 2.2.0 Release
High priority
2 participants
You can’t perform that action at this time.