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

[Review Requested] Update Underway #986

Merged
merged 14 commits into from
Mar 2, 2020
40 changes: 32 additions & 8 deletions content/00.front-matter.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,14 @@
Pandoc automatically inserts title from metadata.yaml, so it is not included in this template.
##}

_A published version of this manuscript from 04 April 2018 is available at <https://doi.org/10.1098/rsif.2017.0387>.
An effort is underway to update the manuscript.
New authors and links to new sections are available in [GitHub Issue #959](https://github.com/greenelab/deep-review/issues/959)._
<!-- include the Font Awesome library, per: https://fontawesome.com/start -->
<link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.7.2/css/all.css">
[
[]{.fas .fa-info-circle .fa-lg} **Update Underway**<br>
agitter marked this conversation as resolved.
Show resolved Hide resolved
A published version of this manuscript from 04 April 2018, termed Version 1.0, is available at <https://doi.org/10.1098/rsif.2017.0387>.
A new effort is underway to update the manuscript to a Version 2.0 that is current as of the first half of 2020.
New authors and links to new sections are available in [GitHub Issue #959](https://github.com/greenelab/deep-review/issues/959).
]{.banner .lightred}

{## Template to insert build date and source ##}
<small><em>
Expand All @@ -25,12 +30,31 @@ on {{manubot.date}}.

## Authors

### Version 2.0 Authors
agitter marked this conversation as resolved.
Show resolved Hide resolved

{% for author in manubot.authors %}
{% if author.v2 -%}
{% if author.orcid is defined -%}
[![ORCID icon](images/orcid.svg){height="11px" width="11px"}](https://orcid.org/{{author.orcid}})
{%- endif %}
{{author.name}}<sup>{{author.affiliation_numbers | join(',')}}♠{%- if author.symbol_str is defined -%},{{author.symbol_str}}{%- endif -%}</sup>
{%- if not loop.last -%}, {%- endif -%}
{%- endif -%}
{% endfor %}

<sup>♠</sup> --- Author order for version 2.0 is currently arbitrary.<br>
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we make it alphabetical so we can give clear instructions to new Version 2.0 authors? That may be too tricky if some authors are both v1 and v2 authors.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wonder if there's a way to have the v1 field become the author contributions grouping there and the v2 field become the same (instead of just true/empty). That opens up the potential to put author contributions on mouseover, and also to sort the list dynamically (say, alphabetically within contribution bands) as people contribute.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tracking the contribution types in the metadata file makes sense to me. Should we save v2 author ordering and mouseover contributions for a follow up issues/pull request?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agree

<sup>†</sup> --- To whom correspondence should be addressed: greenescientist@gmail.com (C.S.G.)

### Version 1.0 Authors

{% for author in manubot.authors %}
{% if author.orcid is defined -%}
[![ORCID icon](images/orcid.svg){height="11px" width="11px"}](https://orcid.org/{{author.orcid}})
{%- endif %}
{{author.name}}<sup>{{author.affiliation_numbers | join(',')}}{%- if author.symbol_str is defined -%},{{author.symbol_str}}{%- endif -%}</sup>
{%- if not loop.last -%}, {%- endif -%}
{% if author.v1 -%}
{% if author.orcid is defined -%}
[![ORCID icon](images/orcid.svg){height="11px" width="11px"}](https://orcid.org/{{author.orcid}})
{%- endif %}
{{author.name}}<sup>{{author.affiliation_numbers | join(',')}}{%- if author.symbol_str is defined -%},{{author.symbol_str}}{%- endif -%}</sup>
{%- if not loop.last -%}, {%- endif -%}
{%- endif -%}
{% endfor %}

<sup>☯</sup> --- Author order was determined with a randomized algorithm<br>
Expand Down
41 changes: 36 additions & 5 deletions content/08.methods.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,37 @@ The ability to irrefutably prove manuscript existence at a past time could be im

### Author contributions

#### Version 2.0

We continued using the open repository on the GitHub version control platform ([`greenelab/deep-review`](https://github.com/greenelab/deep-review)) [@url:https://github.com/greenelab/deep-review], which was established to write the Version 1.0 manuscript.
Drafted multiple sub-sections along with extensive editing, pull request reviews, or discussion:
cgreene marked this conversation as resolved.
Show resolved Hide resolved
Drafted one or more sub-sections: .
Revised specific sub-sections or supervised drafting one or more sub-sections: .
Drafted sub-sections, edited the manuscript, reviewed pull requests, and coordinated co-authors: C.S.G.

{% for v2, authors in manubot.authors | groupby('v2') %}
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this groupby is what is causing the build errors. The changes in 65bfcc9 may not be needed?

{% if v2 -%}
{{ v2 }}: {% for author in authors %}{{author.name}}{%- if not loop.last -%}, {%- endif -%}{% endfor %}
{%- endif -%}
{% endfor %}

<sup>♠</sup> --- Author order for version 2.0 is currently arbitrary.<br>
<sup>†</sup> --- To whom correspondence should be addressed: greenescientist@gmail.com (C.S.G.)

### Version 1.0 Authors

{% for author in manubot.authors %}
{% if author.v1 is defined -%}
{% if author.orcid is defined -%}
[![ORCID icon](images/orcid.svg){height="11px" width="11px"}](https://orcid.org/{{author.orcid}})
{%- endif %}
{{author.name}}<sup>{{author.affiliation_numbers | join(',')}}{%- if author.symbol_str is defined -%},{{author.symbol_str}}{%- endif -%}</sup>
{%- if not loop.last -%}, {%- endif -%}
{%- endif -%}
{% endfor %}

#### Version 1.0

We created an open repository on the GitHub version control platform ([`greenelab/deep-review`](https://github.com/greenelab/deep-review)) [@url:https://github.com/greenelab/deep-review].
Here, we engaged with numerous authors from papers within and outside of the area.
The manuscript was drafted via GitHub commits by {{authors | length}} individuals who met the ICMJE standards of authorship.
Expand All @@ -45,11 +76,11 @@ Drafted sub-sections, edited the manuscript, reviewed pull requests, and coordin

### Competing interests

A.K. is on the Advisory Board of Deep Genomics Inc.
E.F. is a full-time employee of GlaxoSmithKline.
The remaining authors have no competing interests to declare.

The authors last reviewed and approved this competing interests statement on May 26, 2017.
|Author|Competing Interests|Last Reviewed|
cgreene marked this conversation as resolved.
Show resolved Hide resolved
|---|---|---|
{% for author in manubot.authors %}
|{{author.name}}|{{author.coi.string}}|{{author.coi.lastapproved}}|
{% endfor %}

### Acknowledgements

Expand Down
Loading