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]: A database of the healthy human spinal cord morphometry in the PAM50 template space #17

Closed
roboneuro opened this issue Sep 28, 2023 · 169 comments

Comments

@roboneuro
Copy link

roboneuro commented Sep 28, 2023

Submitting author: @valosekj (Jan Valošek)
Repository: https://github.com/valosekj/PAM50-normalized-metrics-paper
Branch with paper.md (empty if default branch): main
Version: r20230904
Editor: @agahkarakuzu
Reviewers: @mathieuboudreau
Reproducible preprint: https://preprint.neurolibre.org/10.55458/neurolibre.00017
Repository archive: 10.5281/zenodo.10002178
Data archive: 10.5281/zenodo.10002180
Book archive: 10.5281/zenodo.10002176
Docker archive: 10.5281/zenodo.10002182

Status

status

Status badge code:

HTML: <a href="https://neurolibre.org/papers/764a9031ba7a9108dc07a0da1c09dfbb"><img src="https://neurolibre.org/papers/764a9031ba7a9108dc07a0da1c09dfbb/status.svg"></a>
Markdown: [![status](https://neurolibre.org/papers/764a9031ba7a9108dc07a0da1c09dfbb/status.svg)](https://neurolibre.org/papers/764a9031ba7a9108dc07a0da1c09dfbb)

Reviewers and authors:

Please avoid lengthy details of difficulties in the review thread. Instead, please create a new issue in the target repository and link to those issues (especially acceptance-blockers) by leaving comments in the review thread below. (For completists: if the target issue tracker is also on GitHub, linking the review thread in the issue or vice versa will create corresponding breadcrumb trails in the link target.)

Reviewer instructions & questions

@mathieuboudreau, your review will be checklist based. Each of you will have a separate checklist that you should update when carrying out your review.
First of all you need to run this command in a separate comment to create the checklist:

@roboneuro generate my checklist

The reviewer guidelines are available here: https://joss.readthedocs.io/en/latest/reviewer_guidelines.html. Any questions/concerns please let @agahkarakuzu know.

Please start on your review when you are able, and be sure to complete your review in the next six weeks, at the very latest

Checklists

@mathieuboudreau, please create your checklist typing: @roboneuro generate my checklist

@roboneuro
Copy link
Author

Hello humans, I'm @roboneuro, a robot that can help you with some common editorial tasks.

For a list of things I can do to help you, just type:

@roboneuro commands

For example, to regenerate the paper pdf after making changes in the paper's md or bib files, type:

@roboneuro generate pdf

@roboneuro
Copy link
Author

Software report:

github.com/AlDanial/cloc v 1.88  T=0.01 s (976.6 files/s, 171163.5 lines/s)
--------------------------------------------------------------------------------
Language                      files          blank        comment           code
--------------------------------------------------------------------------------
TeX                               1             47              8            719
Jupyter Notebook                  1              0            801            104
Markdown                          2             17              0             99
YAML                              5             13             27             86
JSON                              1              0              0              5
Bourne Again Shell                1              0              0              2
--------------------------------------------------------------------------------
SUM:                             11             77            836           1015
--------------------------------------------------------------------------------


gitinspector failed to run statistical information for the repository

@roboneuro
Copy link
Author

Wordcount for paper.md is 692

@roboneuro
Copy link
Author

Failed to discover a Statement of need section in paper

@roboneuro
Copy link
Author

Reference check summary (note 'MISSING' DOIs are suggestions that need verification):

OK DOIs

- None

MISSING DOIs

- 10.1111/jon.12097 may be a valid DOI for title: Spinal cord normalization in multiple sclerosis
- 10.1212/wnl.0000000000008466 may be a valid DOI for title: Clinically relevant cranio-caudal patterns of cervical cord atrophy evolution in MS
- 10.1038/sj.sc.3101375 may be a valid DOI for title: Changes of cervical spinal cord and cervical spinal canal with age in asymptomatic subjects
- 10.1007/s00234-023-03191-0 may be a valid DOI for title: Association between brain and upper cervical spinal cord atrophy assessed by MRI and disease aggressiveness in amyotrophic lateral sclerosis
- 10.1007/s00234-013-1204-3 may be a valid DOI for title: Brain size and white matter content of cerebrospinal tracts determine the upper cervical cord area: evidence from structural brain MRI
- 10.1002/jmri.20545 may be a valid DOI for title: Upper cervical cord area in early relapsing-remitting multiple sclerosis: cross-sectional study of factors influencing cord size
- 10.1177/2192568220934496 may be a valid DOI for title: The Prevalence of Asymptomatic and Symptomatic Spinal Cord Compression on Magnetic Resonance Imaging: A Systematic Review and Meta-analysis
- 10.1038/s41582-019-0270-5 may be a valid DOI for title: Traumatic and nontraumatic spinal cord injury: pathological insights from neuroimaging
- 10.1136/bmjopen-2017-019809 may be a valid DOI for title: Can microstructural MRI detect subclinical tissue injury in subjects with asymptomatic cervical spinal cord compression? A prospective cohort study
- 10.20944/preprints202202.0355.v1 may be a valid DOI for title: Quantitative MR Markers in Non-Myelopathic Spinal Cord Compression: A Narrative Review
- 10.1016/j.nicl.2021.102680 may be a valid DOI for title: Cervical and thoracic cord atrophy in multiple sclerosis phenotypes: Quantification and correlation with clinical disability
- 10.1016/j.neuroimage.2009.12.121 may be a valid DOI for title: Rapid semi-automatic segmentation of the spinal cord from magnetic resonance images: Application in multiple sclerosis
- 10.1038/s41582-019-0303-0 may be a valid DOI for title: Degenerative cervical myelopathy - update and future directions
- 10.1038/sdata.2016.44 may be a valid DOI for title: The brain imaging data structure, a format for organizing and describing outputs of neuroimaging experiments
- 10.3390/brainsci12081088 may be a valid DOI for title: The Pre-Operative Duration of Symptoms: The Most Important Predictor of Post-Operative Efficacy in Patients with Degenerative Cervical Myelopathy
- 10.1016/j.neuroimage.2017.10.041 may be a valid DOI for title: PAM50: Unbiased multimodal template of the brainstem and spinal cord aligned with the ICBM152 space
- 10.1097/01.bsd.0000181294.67212.79 may be a valid DOI for title: Measurement of the cervical spinal cord volume on MRI
- 10.3389/fneur.2016.00238 may be a valid DOI for title: A Review of the Segmental Diameter of the Healthy Human Spinal Cord
- 10.1371/journal.pone.0118576 may be a valid DOI for title: Age, gender and normalization covariates for spinal cord gray matter and total cross-sectional areas at cervical and thoracic levels: A 2D phase sensitive inversion recovery imaging study
- 10.3389/fnimg.2022.1031253 may be a valid DOI for title: Automatic measure and normalization of spinal cord cross-sectional area using the pontomedullary junction
- 10.3174/ajnr.a5162 may be a valid DOI for title: A novel MRI biomarker of spinal cord white matter injury: T2∗-weighted white matter to gray matter signal intensity ratio
- 10.1111/jon.12666 may be a valid DOI for title: Intersubject Variability and Normalization Strategies for Spinal Cord Total Cross-Sectional and Gray Matter Areas
- 10.1016/j.neuroimage.2016.10.009 may be a valid DOI for title: SCT: Spinal Cord Toolbox, an open-source software for processing spinal cord MRI data
- 10.1097/brs.0000000000001842 may be a valid DOI for title: Prevalence and imaging characteristics of nonmyelopathic and myelopathic spondylotic cervical cord compression
- 10.1002/brb3.797 may be a valid DOI for title: Predictors of symptomatic myelopathy in degenerative cervical spinal cord compression
- 10.3174/ajnr.a5163 may be a valid DOI for title: Clinically Feasible Microstructural MRI to Quantify Cervical Spinal Cord Tissue Injury Using DTI, MT, and T2*-Weighted Imaging: Assessment of Normative Data and Reliability
- 10.1007/s00586-012-2176-4 may be a valid DOI for title: Normal morphology, age-related changes and abnormal findings of the cervical spine. Part II: magnetic resonance imaging of over 1,200 asymptomatic subjects
- 10.1016/j.neuroimage.2010.07.033 may be a valid DOI for title: Unbiased average age-appropriate atlases for pediatric studies
- 10.1111/jon.12372 may be a valid DOI for title: Spinal Cord MR Diffusion Properties in Patients with Degenerative Cervical Cord Compression
- 10.1212/nxg.0000000000000419 may be a valid DOI for title: Heritability of cervical spinal cord structure
- 10.1016/s0513-5117(08)79128-2 may be a valid DOI for title: Acute cervical traumatic spinal cord injury: MR imaging findings correlated with neurologic outcome–prospective study with 100 consecutive patients
- 10.1001/jama.2009.594 may be a valid DOI for title: Gray’s Anatomy: The Anatomical Basis of Clinical Practice
- 10.1002/nbm.3530 may be a valid DOI for title: Tract-specific and age-related variations of the spinal cord microstructure: A multi-parametric MRI study using diffusion tensor imaging (DTI) and inhomogeneous magnetization transfer (ihMT)
- 10.21037/qims-21-782 may be a valid DOI for title: Semi-automated detection of cervical spinal cord compression with the Spinal Cord Toolbox
- 10.3389/fneur.2021.637198 may be a valid DOI for title: Normalization of Spinal Cord Total Cross-Sectional and Gray Matter Areas as Quantified With Radially Sampled Averaged Magnetization Inversion Recovery Acquisitions
- 10.1155/2014/719520 may be a valid DOI for title: Automatic Labeling of Vertebral Levels Using a Robust Template-Based Approach

INVALID DOIs

- None

@agahkarakuzu
Copy link
Collaborator

agahkarakuzu commented Sep 28, 2023

@valosekj I am working on a solution that will:

  1. Let you get rid of all the manual html tags you had to put in markdown cells (<p style="align-blahblah">).
  2. This will enable adding proper citations, by using the {cite:p}key commands.
  3. Then your references will be automatically parsed in the jupyter book, then will be inserted in the PDF.

I'll let you know today when I confirm proper functionality.

@roboneuro
Copy link
Author

👉📄 Download article proof 📄 View article proof on GitHub 📄 👈

@agahkarakuzu
Copy link
Collaborator

agahkarakuzu commented Sep 29, 2023

@Valosek currently in your book the citations are in plaintext format, not linked to the bibliography you provided (paper.bib). I know this was because I suggested taking the rrsg2020 index.ipynb as a reference.

To fix this issue, I have made a few changes in the rrsg2020/paper repository, which can be reflected here for proper use of citations:

  1. No more <p style="text-align:justify;"></p> wrapping around the text. CSS related configs will instead live in content/_static/custom.css with the following content:
p {
  text-align: justify;
}
a {
  color: #870000!important;
}
a:hover {
  color: brick!important;
}
a:visited {
  color: #6f42c1!important;
}
body, h1, h2, h3, h4, h5 {
    font-family: 'STIX Two Text';
}
h1 {
    color: #342727!important;
}
.caption {
    text-align:justify;
    line-height:1.25;
    font-size:80%
}

#site-navigation {
    display: none;
}

#main-content{
    margin: 0 auto;
}

.fa, .far, .fas {
    color: red;
}

.header-article::after{
  content: url('https://neurolibre.org/assets/joss2-b7ea8dd1f24ce2b0825db17e3495576253ba4c64df3384a66354713d76c40a75.svg');
  width: 150px; 
  height: 80px;
  position: absolute;
  right: 10px;
}

.header-article::before{
  content: url('https://raw.githubusercontent.com/neurolibre/brand/b5e10e051a0059824ca2f4204e1288927e551d49/svg/neurolibre_logo.svg');
  width: 33px; 
  height: 33px;
  position: absolute;
  left: 10px;
}
  1. Make jupyter book build use this custom css file and the paper.bib (instead of references.bib by updating the content/_config.yml:
sphinx:
  recursive_update          : false # A boolean indicating whether to overwrite the Sphinx config (true) or recursively update
    bibtex_reference_style: author_year
    bibtex_default_style: plain
    bibtex_tooltips: true
    html_static_path: ['_static']
    html_css_files: ['custom.css']

bibtex_bibfiles:
  - ../paper.bib
  1. Update your index.ipynb to use {cite:p}bibtex-key citation directives instead of plain text. You can take a look at the latest RRSG notebook to see how to manage successive citations or (abc et al. 2010) (use {cite:p}) vs abc et. al. (2010) formatting (use {cite:t}).

🚨 Make sure that the reference directives are NOT between html tags, otherwise they won't be interpreted. Overall, keeping html tags to a minimum is good practice when writing a jupyter book. Unfortunately, there is currently no way to tag/link/reference interactive figures. So those will be followed by a markdown cell containing the caption text, and you'll need to manually enumerate the figures.

Eventually, it should look like this: https://preview.neurolibre.org/book-artifacts/rrsg2020/github.com/paper/c0d7479f87cb0ef959ce87ba3a2bffe2ab44c330/_build/_page/index/singlehtml/

I am working on the last bit to automatically populate the PDF with the citations in context.

Thank you for your patience! If you don't have it in you to deal with any of these, happy to send you a PR.

@valosekj
Copy link

  1. No more <p style="text-align:justify;"></p> wrapping around the text. CSS related configs will instead live in content/_static/custom.css with the following content:

  2. Make jupyter book build use this custom css file and the paper.bib (instead of references.bib by updating the content/_config.yml:

Done in valosekj/PAM50-normalized-metrics-paper@c0cc15b and valosekj/PAM50-normalized-metrics-paper@4b1827f.

  1. Update your index.ipynb to use {cite:p}bibtex-key citation directives instead of plain text. You can take a look at the latest RRSG notebook to see how to manage successive citations or (abc et al. 2010) (use {cite:p}) vs abc et. al. (2010) formatting (use {cite:t}).

Okay! I tried the following syntax in my content/index.ipynb:

{cite:p}(Losseff et al., 1996; Mina et al., 2021; Rocca et al., 2019)

but it doesn't seem to be working:

image

@agahkarakuzu
Copy link
Collaborator

You should use the citation keys from the bibtex file.

Let say for John Doe et al. 2017, the respective bibtex entry is

article{doe2017-xy,
Blah,
Blah,
}

Then in the text you {cite:p}'doe2017-xy' (quotes are gonna be the funky ones, can't find them on my phone).

There are many examples in the rrsg notebook. You can use bibdesk to load and navigate your paper.bib, and to copy/paste cite commands.

@valosekj
Copy link

valosekj commented Oct 4, 2023

Do you have any ideas why there is extra white space between the tables 2, 3, and 4 and their captions?

image

Table 1 is rendered properly:

image

Code for all tables is pretty similar; see here.

@agahkarakuzu
Copy link
Collaborator

@roboneuro build book

@roboneuro
Copy link
Author

roboneuro commented Oct 6, 2023

🟢 Successfully built

Status: Success b02814a8
Last updated: 2023-10-06 06:00:14 PDT

ℹ️ See details
:confetti_ball: Roboneuro will send you the book URL.

@roboneuro
Copy link
Author

🎊🎊🎊
Congratulations to the authors on constructing the neurolibre reproducible preprint (NRP)! They've certainly stirred some upright excitement by building a database of healthy human spinal cord morphometry, making "spinal-tific" data open-source for all!
🌺 Take a loot at the latest version of your NRP!

@valosekj
Copy link

valosekj commented Oct 6, 2023

Regarding my previous comment about the white space below the tables, it should now be resolved by this recent commit. Can you rebuild the book one more time?

@agahkarakuzu
Copy link
Collaborator

@roboneuro build book

@roboneuro
Copy link
Author

👀 Looks like the reproducible preprint you requested has been already built:

[{"time_added":"2023-10-06 12:59:08 +0000","book_url":"https://preview.neurolibre.org/book-artifacts/valosekj/github.com/PAM50-normalized-metrics-paper/f447654f129f56d3759cb2e4947b232b04e38007/_build/_page/index/singlehtml/","download_url":null}]

@agahkarakuzu
Copy link
Collaborator

@valosekj the book is already built at the latest commit, which includes the one you mention. You may want to try figure layout margins, fig.update_layout(margin=dict(b=0)).

@agahkarakuzu
Copy link
Collaborator

@roboneuro build book

@roboneuro
Copy link
Author

roboneuro commented Oct 6, 2023

🟢 Successfully built

Status: Success 57765875
Last updated: 2023-10-06 07:54:59 PDT

ℹ️ See details
:confetti_ball: Roboneuro will send you the book URL.

@roboneuro
Copy link
Author

🎊🎊🎊
Congratulations to the authors for constructing a neurolibre reproducible preprint (NRP) that's a spinal sensation! Your open-source database on healthy human spinal cord morphometry will surely be a backbone for researchers seeking normative values in the PAM50 template space.
🌺 Take a loot at the latest version of your NRP!

@agahkarakuzu
Copy link
Collaborator

Ok great! Looks like the issue has been resolved.

@agahkarakuzu
Copy link
Collaborator

@roboneuro build extended pdf

@roboneuro
Copy link
Author

Done, data archive is now zenodo.10002180

@agahkarakuzu
Copy link
Collaborator

@roboneuro set 10.5281/zenodo.10002182 as docker archive

@roboneuro
Copy link
Author

Done, docker archive is now 10.5281/zenodo.10002182

@agahkarakuzu
Copy link
Collaborator

@roboneuro recommend-accept

@roboneuro
Copy link
Author

Attempting dry run of processing paper acceptance...

@roboneuro
Copy link
Author

Reference check summary (note 'MISSING' DOIs are suggestions that need verification):

OK DOIs

- 10.1111/jon.12097 is OK
- 10.1212/wnl.0000000000008466 is OK
- 10.1038/s41592-019-0686-2 is OK
- 10.1038/sj.sc.3101375 is OK
- 10.1007/s00234-023-03191-0 is OK
- 10.1007/s00234-013-1204-3 is OK
- 10.1093/brain/119.3.701 is OK
- 10.1002/jmri.20545 is OK
- 10.1177/2192568220934496 is OK
- 10.1038/s41596-021-00588-0 is OK
- 10.1038/s41597-021-01044-0 is OK
- 10.1038/s41582-019-0270-5 is OK
- 10.1136/bmjopen-2017-019809 is OK
- 10.1016/j.nicl.2021.102680 is OK
- 10.1016/j.neuroimage.2018.09.081 is OK
- 10.3174/ajnr.a5427 is OK
- 10.1016/j.neuroimage.2009.12.121 is OK
- 10.1038/s41582-019-0303-0 is OK
- 10.1038/sdata.2016.44 is OK
- 10.3390/brainsci12081088 is OK
- 10.1016/j.neuroimage.2017.10.041 is OK
- 10.1097/01.bsd.0000181294.67212.79 is OK
- 10.3389/fneur.2016.00238 is OK
- 10.1371/journal.pone.0118576 is OK
- 10.3389/fnimg.2022.1031253 is OK
- 10.3174/ajnr.a5162 is OK
- 10.1111/jon.12666 is OK
- 10.1016/j.neuroimage.2016.10.009 is OK
- 10.1097/brs.0000000000001842 is OK
- 10.1002/brb3.797 is OK
- 10.3174/ajnr.a5163 is OK
- 10.1007/s00586-012-2176-4 is OK
- 10.1016/j.neuroimage.2010.07.033 is OK
- 10.1111/jon.12372 is OK
- 10.1212/nxg.0000000000000401 is OK
- 10.1148/radiol.2433060583 is OK
- 10.1002/nbm.3530 is OK
- 10.21037/qims-21-782 is OK
- 10.3389/fneur.2021.637198 is OK
- 10.1097/00007632-199903150-00023 is OK
- 10.1155/2014/719520 is OK
- 10.1038/s41597-022-01571-4 is OK
- 10.5281/zenodo.6511596 is OK
- 10.31219/osf.io/h89js is OK
- 10.1371/journal.pcbi.1009651 is OK
- 10.1371/journal.pcbi.1011230 is OK

MISSING DOIs

- 10.1001/jama.2009.594 may be a valid DOI for title: Gray’s Anatomy: The Anatomical Basis of Clinical Practice

INVALID DOIs

- None

@roboneuro
Copy link
Author

👋 @openjournals/executable-eics, this paper is ready to be accepted and published.

Check final proof 👉📄 Download article

If the paper PDF and the deposit XML files look good in neurolibre/preprints#57, then you can now move forward with accepting the submission by compiling again with the command @editorialbot accept

@agahkarakuzu
Copy link
Collaborator

@roboneuro recommend-accept

@roboneuro
Copy link
Author

Attempting dry run of processing paper acceptance...

@roboneuro
Copy link
Author

Reference check summary (note 'MISSING' DOIs are suggestions that need verification):

OK DOIs

- 10.1111/jon.12097 is OK
- 10.1212/wnl.0000000000008466 is OK
- 10.1038/s41592-019-0686-2 is OK
- 10.1038/sj.sc.3101375 is OK
- 10.1007/s00234-023-03191-0 is OK
- 10.1007/s00234-013-1204-3 is OK
- 10.1093/brain/119.3.701 is OK
- 10.1002/jmri.20545 is OK
- 10.1177/2192568220934496 is OK
- 10.1038/s41596-021-00588-0 is OK
- 10.1038/s41597-021-01044-0 is OK
- 10.1038/s41582-019-0270-5 is OK
- 10.1136/bmjopen-2017-019809 is OK
- 10.1016/j.nicl.2021.102680 is OK
- 10.1016/j.neuroimage.2018.09.081 is OK
- 10.3174/ajnr.a5427 is OK
- 10.1016/j.neuroimage.2009.12.121 is OK
- 10.1038/s41582-019-0303-0 is OK
- 10.1038/sdata.2016.44 is OK
- 10.3390/brainsci12081088 is OK
- 10.1016/j.neuroimage.2017.10.041 is OK
- 10.1097/01.bsd.0000181294.67212.79 is OK
- 10.3389/fneur.2016.00238 is OK
- 10.1371/journal.pone.0118576 is OK
- 10.3389/fnimg.2022.1031253 is OK
- 10.3174/ajnr.a5162 is OK
- 10.1111/jon.12666 is OK
- 10.1016/j.neuroimage.2016.10.009 is OK
- 10.1097/brs.0000000000001842 is OK
- 10.1002/brb3.797 is OK
- 10.3174/ajnr.a5163 is OK
- 10.1007/s00586-012-2176-4 is OK
- 10.1016/j.neuroimage.2010.07.033 is OK
- 10.1111/jon.12372 is OK
- 10.1212/nxg.0000000000000401 is OK
- 10.1148/radiol.2433060583 is OK
- 10.1002/nbm.3530 is OK
- 10.21037/qims-21-782 is OK
- 10.3389/fneur.2021.637198 is OK
- 10.1097/00007632-199903150-00023 is OK
- 10.1155/2014/719520 is OK
- 10.1038/s41597-022-01571-4 is OK
- 10.5281/zenodo.6511596 is OK
- 10.31219/osf.io/h89js is OK
- 10.1371/journal.pcbi.1009651 is OK
- 10.1371/journal.pcbi.1011230 is OK

MISSING DOIs

- 10.1001/jama.2009.594 may be a valid DOI for title: Gray’s Anatomy: The Anatomical Basis of Clinical Practice

INVALID DOIs

- None

@roboneuro
Copy link
Author

👋 @openjournals/executable-eics, this paper is ready to be accepted and published.

Check final proof 👉📄 Download article

If the paper PDF and the deposit XML files look good in neurolibre/preprints#58, then you can now move forward with accepting the submission by compiling again with the command @editorialbot accept

@agahkarakuzu
Copy link
Collaborator

@roboneuro sync pdf

@roboneuro
Copy link
Author

I'm sorry human, I don't understand that. You can see what commands I support by typing:

@roboneuro commands

@agahkarakuzu
Copy link
Collaborator

@roboneuro production sync pdf

@roboneuro
Copy link
Author

🌱♻️📄 Synced the summary PDF from the source, should be now available at https://preprint.neurolibre.org/10.55458/neurolibre.00017.pdf?no-cache

@agahkarakuzu
Copy link
Collaborator

@roboneuro publish

@roboneuro
Copy link
Author

I'm sorry human, I don't understand that. You can see what commands I support by typing:

@roboneuro commands

@agahkarakuzu
Copy link
Collaborator

@roboneuro accept

@roboneuro
Copy link
Author

Doing it live! Attempting automated processing of paper acceptance...

@roboneuro
Copy link
Author

Ensure proper citation by uploading a plain text CITATION.cff file to the default branch of your repository.

If using GitHub, a Cite this repository menu will appear in the About section, containing both APA and BibTeX formats. When exported to Zotero using a browser plugin, Zotero will automatically create an entry using the information contained in the .cff file.

You can copy the contents for your CITATION.cff file here:

CITATION.cff

cff-version: "1.2.0"
authors:
- family-names: Valošek
  given-names: Jan
  orcid: "https://orcid.org/0000-0002-7398-4990"
- family-names: Bédard
  given-names: Sandrine
  orcid: "https://orcid.org/0000-0001-9859-1133"
- family-names: Keřkovský
  given-names: Miloš
  orcid: "https://orcid.org/0000-0003-0587-9897"
- family-names: Rohan
  given-names: Tomáš
  orcid: "https://orcid.org/0000-0002-7105-583X"
- family-names: Cohen-Adad
  given-names: Julien
  orcid: "https://orcid.org/0000-0003-3662-9532"
doi: 10.55458
message: To reference this work, please cite our reproducible preprint
  in NeuroLibre.
preferred-citation:
  authors:
  - family-names: Valošek
    given-names: Jan
    orcid: "https://orcid.org/0000-0002-7398-4990"
  - family-names: Bédard
    given-names: Sandrine
    orcid: "https://orcid.org/0000-0001-9859-1133"
  - family-names: Keřkovský
    given-names: Miloš
    orcid: "https://orcid.org/0000-0003-0587-9897"
  - family-names: Rohan
    given-names: Tomáš
    orcid: "https://orcid.org/0000-0002-7105-583X"
  - family-names: Cohen-Adad
    given-names: Julien
    orcid: "https://orcid.org/0000-0003-3662-9532"
  date-published: 2023-10-17
  doi: 10.55458/neurolibre.00017
  journal: NeuroLibre Reproducible Preprints
  publisher:
    name: NeuroLibre
  title: A database of the healthy human spinal cord morphometry in the
    PAM50 template space
  type: preprint
  url: "https://neurolibre.org/papers/10.55458/neurolibre.00017"
title: A database of the healthy human spinal cord morphometry in the
  PAM50 template space

If the repository is not hosted on GitHub, a .cff file can still be uploaded to set your preferred citation. Users will be able to manually copy and paste the citation.

Find more information on .cff files here and here.

@roboneuro
Copy link
Author

🌰🌱🌺 THIS IS NOT A DRILL, YOU HAVE JUST PUBLISHED A NEUROLIBRE REPRODUCIBLE PREPRINT! 🌺🌸🍀

Here's what you must now do:

  1. Check final PDF and Crossref metadata that was deposited 👉 Creating pull request for 10.55458.neurolibre.00017 preprints#59
  2. Wait a couple of minutes, then verify that the paper DOI resolves https://doi.org/
  3. If everything looks good, then close this review issue.
  4. Party like you just published more than a PDF! 🎉🌈🦄💃👻🤘

Any issues? Notify your editorial technical team...

@agahkarakuzu
Copy link
Collaborator

@valosekj @jcohenadad @sandrinebedard thank you for this great submission, happy to see it on the front page of NeuroLibre!

You can see that the DOI resolves into the publication page:

https://doi.org/10.55458/neurolibre.00017

Above you can follow instructions to add cff to any repo if you would like others to cite this preprint.

For this submission, I had to edit the container archive, as repo2data was not called to download the data in the notebook. I updated the description so that people can download the data from zenodo and mount it to the container simply by following those instructions.

As this is a beta release, each submission helps us identify and resolve issues, so thank you for your patience, and looking forward to more submissions! Instead of a PDF, you have 4 DOIs archiving reproducibility assets (including a 2.2GB Docker image), one reproducible preprint with interactive figures , all inter-linked through https://doi.org/10.55458/neurolibre.00017.

You will be notified by ResearchGate by tomorrow, but it takes some more time for google scholar's web spiders to discover these. Either way, the content is officially registered by Crossref and you can cite it as you see fit.

@jcohenadad
Copy link

This is so exciting! Thank you @agahkarakuzu and @roboneuro 😊

@roboneuro
Copy link
Author

roboneuro commented Oct 17, 2023

🌰 🌱 🌺 Congratulations on your NeuroLibre Reproducible Preprint (NRP)! 🍀 🚀 ♻️

By publishing this NRP, you've gone beyond simply posting another traditional preprint, demonstrating your commitment to transparency and reproducibility in presenting your new findings. This achievement is certainly something to take pride in, and if you wish to showcase it in your repository:

Markdown:
[![DOI](https://neurolibre.org/papers/10.55458/neurolibre.017/status.svg)](https://doi.org/10.55458/neurolibre.017)

HTML:
<a style="border-width:0" href="https://doi.org/10.55458/neurolibre.017">
  <img src="https://neurolibre.org/papers/10.55458/neurolibre.017/status.svg" alt="DOI badge" >
</a>

reStructuredText:
.. image:: https://neurolibre.org/papers/10.55458/neurolibre.017/status.svg
   :target: https://doi.org/10.55458/neurolibre.017

This is how it will look in your, e.g., README:

Note

The DOI formatted badges are not rendering yet, please use the following:

status

We need your help!

NeuroLibre is a community-run reproducible preprint server and relies upon volunteer effort. If you'd like to support us please consider doing either one (or both) of the the following:

  • Volunteering to become a technical screener
  • Contribute to the development

For details, please visit our documentation

@valosekj
Copy link

Thank you @agahkarakuzu! 💯

@valosekj
Copy link

Markdown:
[![DOI](https://neurolibre.org/papers/10.55458/neurolibre.017/status.svg)](https://doi.org/10.55458/neurolibre.017)

HTML:
<a style="border-width:0" href="https://doi.org/10.55458/neurolibre.017">
  <img src="https://neurolibre.org/papers/10.55458/neurolibre.017/status.svg" alt="DOI badge" >
</a>

reStructuredText:
.. image:: https://neurolibre.org/papers/10.55458/neurolibre.017/status.svg
   :target: https://doi.org/10.55458/neurolibre.017

Just a nitpick; the DOI in the above-mentioned code section should be https://doi.org/10.55458/neurolibre.00017 (i.e., with two extra leading zeros). When adding these two zeros, the badge is working!

@sandrinebedard
Copy link

Thank you @agahkarakuzu!

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

No branches or pull requests

5 participants