8000 Revise package citation guidance · Issue #1303 · wadpac/GGIR · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Revise package citation guidance #1303

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.

Sign up for GitHub

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

Jump to bottom
Open
vincentvanhees opened this issue May 13, 2025 · 0 comments
Open

Revise package citation guidance #1303

vincentvanhees opened this issue May 13, 2025 · 0 comments
Labels
documentation

Comments

@vincentvanhees
Copy link
Member
vincentvanhees commented May 13, 2025 •
edited
Loading

Current situation:

  1. When verbose = TRUE (default), GGIR prints to the R console the text: "Do not forget to cite GGIR in your publications via a version number and Migueles et al. 2019 JMPB. doi: 10.1123/jmpb.2018-0063.". This paper reflects an increasingly outdated overview of GGIR. By now the GGIR documentation itself should be the starting point for anyone who wants to learn about GGIR. Further, it gives the strange impression that the paper to describe the software is more valuable academically than the research software.
  2. In the CITATION file, rendered here, it shows a list of publications to cite without any guidance on which of these to cite when. That said, it seems impossible to include narrative guidance inside the CITATION file.
  3. In the CRAN vignette there is a section that provides more detailed guidance on what to cite when, but it is unpractical that this information is not available in the GitHub pages.
  4. We do not encourage citing the software itself via its Zenodo doi.

Proposed revision:

  • Replace CITATION file content by only the Zenodo doi for GGIR to simplify the guidance on how to cite the GGIR as a software.
  • Replace console message by encouragement to cite the zenodo doi and refer to other resources for more detailed guidance.
  • Add citation suggestions inside the relevant chapters of the GGIR documentation.
  • Remove citation suggestion from CRAN page as this will now be redundant.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@vincentvanhees
0