Skip to content

Conversation

@yibeichan
Copy link
Contributor

Summary

Update all citation references to include the recently published JMIR paper describing the ReproSchema ecosystem.

Changes

  • Updated CITATION.cff with complete author list and JMIR publication details as preferred citation
  • Added Citation section to README.md with formatted paper reference
  • Updated docs/index.md to include both the paper citation and software DOI

Related Publication

Chen Y, Jarecka D, Abraham S, et al. Standardizing Survey Data Collection to Enhance Reproducibility: Development and Comparative Evaluation of the ReproSchema Ecosystem. J Med Internet Res 2025;27:e63343. DOI: 10.2196/63343

Testing

  • Verified CITATION.cff follows CFF v1.2.0 schema
  • Checked all author names match the publication
  • Confirmed DOI links are functional

This ensures users properly cite the academic publication when using ReproSchema in their research.

- Update CITATION.cff with complete author list and JMIR paper details
- Add Citation section to README.md
- Update docs/index.md with both paper and software citations
@yibeichan yibeichan requested a review from Copilot July 27, 2025 03:41
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

Updates citation references across the repository to include the newly published JMIR 2025 paper as the preferred citation for ReproSchema, replacing the previous Zenodo-only citation approach.

  • Updated CITATION.cff with complete author list and JMIR publication as preferred citation
  • Added citation sections to documentation files with formatted paper reference
  • Expanded README.md with comprehensive usage examples and ecosystem overview

Reviewed Changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.

File Description
CITATION.cff Added JMIR paper as preferred citation with full author list and publication details
README.md Added Citation section and expanded content with usage examples and ecosystem documentation
docs/index.md Updated citation instructions to prioritize JMIR paper over software DOI
Comments suppressed due to low confidence (2)


For the software itself, you can use this DOI:

- [doi:10.5281/zenodo.4064940](https://doi.org/10.5281/zenodo.4064940)
Copy link

Copilot AI Jul 27, 2025

Choose a reason for hiding this comment

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

[nitpick] The formatting shows inconsistent spacing and hyphen usage compared to the previous Zenodo link format. Consider maintaining consistent list formatting.

Suggested change
- [doi:10.5281/zenodo.4064940](https://doi.org/10.5281/zenodo.4064940)
- [doi:10.5281/zenodo.4064940](https://doi.org/10.5281/zenodo.4064940)

Copilot uses AI. Check for mistakes.
- Update NLM CDE link to use new URL (cde.nlm.nih.gov)
- Update CEDAR Metadata Model links to use base URL
- Update visualize.md to reference main branch for demo protocol
- Helps avoid rate limiting issues during link checks
@yibeichan yibeichan merged commit ac35394 into main Jul 27, 2025
5 checks passed
@yibeichan yibeichan deleted the docs/improve-readme-structure branch July 27, 2025 04:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants