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

Update plos.csl (issues re. [internet/preprint]) #4323

Merged
merged 3 commits into from Oct 2, 2019

Conversation

@POBrien333
Copy link
Contributor

commented Sep 27, 2019

Fix issues regarding [internet] and [preprint] for PLoS as per: #4138 (and pointed out again here: #4140 (comment))

Please check carefully if I did this correctly. :)

@dhimmel, can you give this a test ride?

Fix issues regarding [internet] and [preprint] for PLoS as per: #4138 (and pointed out again here: #4140 (comment))

Please check carefully if I did this correctly. :)
@csl-bot

This comment has been minimized.

Copy link

commented Sep 27, 2019

Awesome! You just created a pull request to the Citation Styles Language styles repository. One of our human volunteers will try to get in touch soon (usually within a week). In the meantime, I will run some automated checks. You should be notified of the results in a few minutes.

If you haven't done so yet, please make sure your style validates and follows all our other Style Requirements.

To update this pull request, visit the "Files changed" tab above, and click on the pencil icon (see below) in the top-right corner of your style to start editing.

If you have any questions, please leave a comment and we'll get back to you. While we usually respond in English, feel free to write in whatever language you're most comfortable.

@POBrien333 POBrien333 changed the title Update plos.csl Update plos.csl (issues re. [internet/preprint]) Sep 27, 2019
@csl-bot

This comment has been minimized.

Copy link

commented Sep 27, 2019

😃 Your submission passed all our automated tests.

Below are some sample citations generated based on your proposed changes:

plos.csl (modified style; unchanged output for sample items)
[1,2]
[3,4]

1. Hancké B, Rhodes M, Thatcher M, editors. Beyond varieties of capitalism : Conflict, contradiction, and complementarities in the European economy. Oxford and New York: Oxford University Press; 2007.
2. CSL search by example. In: Citation Style Editor [Internet]. 2012 [cited 15Dec2012]. Available: http://editor.citationstyles.org/searchByExample/
3. Mares I. Firms and the welfare state: When, why, and how does social policy matter to employers? In: Hall PA, Soskice D, editors. Varieties of capitalism The institutional foundations of comparative advantage. New York: Oxford University Press; 2001. pp. 184–213.
4. Fenner M, Crosas M, Grethe JS, Kennedy D, Hermjakob H, Rocca-Serra P, et al. A data citation roadmap for scholarly data repositories. Scientific Data. 2019;6: 28. doi:10.1038/s41597-019-0031-8
@dhimmel

This comment has been minimized.

Copy link

commented Sep 27, 2019

In greenelab/meta-review#261, I evaluate the effect of the new PLOS style from 82df7b5 on our reference formatting. The result is available in manuscript-1.0.18-d0462c5.pdf.

I can confirm that [Internet] no longer appears for references 1, 10, 15, 25 as documented in #4138 (comment).

[Preprint] does not appear for arXiv references, but also appears for references 23, 35, 45, 60, 69 which are not preprints (some are blog posts, but some are journal articles). Furthermore, preprint does not appear for bioRxiv references. Our CSL JSON is located here, if that helps with debugging. I wonder if the method for detecting preprints is too imprecise? Given the current CSL JSON schema, perhaps it is best to not assume anything is a preprint (or perhaps to hardcode a list of preprint servers).

@POBrien333

This comment has been minimized.

Copy link
Contributor Author

commented Sep 29, 2019

Re [Preprint]:
The conditional tests for article-journal and reports.
It then only prints [preprint] if the item does NOT have a volume and a page.

Item 23 and 35 are blog articles and should NOT be article-journals.
The others a normal papers from journals and as far as I see it does that correctly, print [Preprint] if if there is no volume and or page assigned, meaning it is in preprint.

@csl-bot

This comment has been minimized.

Copy link

commented Sep 29, 2019

😃 Your submission passed all our automated tests.

Below are some sample citations generated based on your proposed changes:

plos.csl (modified style; unchanged output for sample items)
[1,2]
[3,4]

1. Hancké B, Rhodes M, Thatcher M, editors. Beyond varieties of capitalism : Conflict, contradiction, and complementarities in the European economy. Oxford and New York: Oxford University Press; 2007.
2. CSL search by example. In: Citation Style Editor [Internet]. 2012 [cited 15Dec2012]. Available: http://editor.citationstyles.org/searchByExample/
3. Mares I. Firms and the welfare state: When, why, and how does social policy matter to employers? In: Hall PA, Soskice D, editors. Varieties of capitalism The institutional foundations of comparative advantage. New York: Oxford University Press; 2001. pp. 184–213.
4. Fenner M, Crosas M, Grethe JS, Kennedy D, Hermjakob H, Rocca-Serra P, et al. A data citation roadmap for scholarly data repositories. Scientific Data. 2019;6: 28. doi:10.1038/s41597-019-0031-8
@dhimmel

This comment has been minimized.

Copy link

commented Sep 29, 2019

The others a normal papers from journals and as far as I see it does that correctly, print [Preprint] if if there is no volume and or page assigned, meaning it is in preprint.

Unfortunately the meaning of "preprint" differs from the obvious interpretation of an article prior to print publication. Instead in the life sciences, the term is defined as such:

A preprint is a complete scientific manuscript that is uploaded by the authors to a public server. The preprint contains complete data and methodologies; it is often the same manuscript being submitted to a journal (see FAQ on submitting preprints). After a brief quality-control inspection to ensure that the work is scientific in nature, the author’s manuscript is posted within a day or so on the Web without peer review and can be viewed without charge by anyone in the world.

The key distinctions is that preprints are posted at the author's discretion, independent of approval from peer review. They are usually hosted on preprint servers that are distinct from the journals, although some journals like F1000 Research also make submitted articles available prior to peer review and acceptance and these could be called preprints (but this is a corner case).

The PLOS guidelines add [Preprint] to references under the category "Deposited articles (preprints, e-prints, or arXiv)`.

The conditional tests for article-journal and reports. It then only prints [preprint] if the item does NOT have a volume and a page.

I'd suggest never labeling an article-journal with [Preprint]. Labeling reports without a volume and page as a [Preprint] would probably be right more than not... although ultimately it's a tough workaround to CSL JSON's lack of an article-preprint type.

Item 23 and 35 are blog articles and should NOT be article-journals.

Good catch. Will look into fixing my metadata.

@POBrien333

This comment has been minimized.

Copy link
Contributor Author

commented Sep 29, 2019

I see. In that case that conditional doesn't make sense. I've removed it again.
I don't think there is any other way we could test for with CSL.

@adam3smith

This comment has been minimized.

Copy link
Member

commented Sep 29, 2019

We have discussed using article for preprints and I'm still open for that, but it's obviously not in the specs. The alternative would be to just wait for CSL 1.1/1.2 and introduce a preprint item type.

@csl-bot

This comment has been minimized.

Copy link

commented Sep 29, 2019

😃 Your submission passed all our automated tests.

Below are some sample citations generated based on your proposed changes:

plos.csl (modified style; unchanged output for sample items)
[1,2]
[3,4]

1. Hancké B, Rhodes M, Thatcher M, editors. Beyond varieties of capitalism : Conflict, contradiction, and complementarities in the European economy. Oxford and New York: Oxford University Press; 2007.
2. CSL search by example. In: Citation Style Editor [Internet]. 2012 [cited 15Dec2012]. Available: http://editor.citationstyles.org/searchByExample/
3. Mares I. Firms and the welfare state: When, why, and how does social policy matter to employers? In: Hall PA, Soskice D, editors. Varieties of capitalism The institutional foundations of comparative advantage. New York: Oxford University Press; 2001. pp. 184–213.
4. Fenner M, Crosas M, Grethe JS, Kennedy D, Hermjakob H, Rocca-Serra P, et al. A data citation roadmap for scholarly data repositories. Scientific Data. 2019;6: 28. doi:10.1038/s41597-019-0031-8
@dhimmel

This comment has been minimized.

Copy link

commented Sep 29, 2019

I rebuilt the manuscript with the style from dfe2507:
manuscript-1.0.19-468ace4.pdf.

The PR looks good on my end! An improvement for sure. Thanks @POBrien333.

@adam3smith adam3smith merged commit 9d67d08 into citation-style-language:master Oct 2, 2019
1 check passed
1 check passed
continuous-integration/travis-ci/pr The Travis CI build passed
Details
@adam3smith

This comment has been minimized.

Copy link
Member

commented Oct 2, 2019

Thanks both!

@bwiernik

This comment has been minimized.

Copy link
Contributor

commented Oct 2, 2019

@adam3smith From my perspective, the spec doesn’t really clearly define the meaning of any item type, so conventions about type usage are important to consider.

The current typical conventional for preprints is to use article-journal or report. I think we agree that doesn’t make much sense. article is essentially unused, and I agree with your earlier comments that it’s a good conceptual fit. In CSL 1.2/2, the name could potentially be changed to preprint, but it seems like a waste to not move toward a convention of using it for this purpose now. That’s the assumption being used with APA, and article isn’t otherwise being printed at all with this style.

@dhimmel

This comment has been minimized.

Copy link

commented Oct 2, 2019

From my perspective, the spec doesn’t really clearly define the meaning of any item type, so conventions about type usage are important to consider.

Agreed although this should be fixed by updating the schema with definitions.

seems like a waste to not move toward a convention of using it for this purpose now.

I'm happy to use the article type for preprints in CSL JSON that I produce. However, users receive CSL JSON from many sources, and I don't think it's practical to expect all users of a given style will update CSL JSON they receive to use article for preprints. In other words, it's probably dangerous for a style to assume article means preprint.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
5 participants
You can’t perform that action at this time.