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

add author list explicitly to the vignette #8

Closed
nickreich opened this issue Jan 25, 2024 · 5 comments
Closed

add author list explicitly to the vignette #8

nickreich opened this issue Jan 25, 2024 · 5 comments

Comments

@nickreich
Copy link
Contributor

Depending on how the authorship shakes out, I'd recommend adding the authors directly to the HTML vignette as well as the package contributors.

@lshandross lshandross transferred this issue from Infectious-Disease-Modeling-Hubs/hubEnsembles Feb 12, 2024
@lshandross
Copy link
Collaborator

@nickreich we've added the authors (minus the consortium authorship) to the manuscript with the commits b15891c and 7bd3110. In terms of the package contributors, can you clarify how their names should be displayed or marked (since there's a lot of overlap in manuscript authors and package contributors)?

@nickreich
Copy link
Contributor Author

I'm not sure I fully understand your question. I was imagining that anyone who was not already listed as a package author/contributor could be added to the package in a ctb role.

@lshandross
Copy link
Collaborator

I guess I was confused where exactly these contributors are supposed to be listed. Is this issue saying the package contributors should be added to the hubEnsembles description file, the vignette that will live in the hubEnsembles, the actual manuscript in the hubEnsemblesManuscript repo, or some combination of the above? If they should be added somewhere in the vignette and/or manuscript, is there a specific way the contributor vs author designation should be expressed? (I think your most recent comment means contributors should be added to the description file, but I just want to get confirmation on this)

Also, is there a specific way a consortium authorship should be formatted? I found a resource from Nature, but I don't know if stats or software papers follow a different convention https://www.nature.com/documents/nr-consortia-formatting.pdf

eahowerton added a commit that referenced this issue Mar 14, 2024
@nickreich
Copy link
Contributor Author

nickreich commented Mar 26, 2024

  • PACKAGE: Yes, my comment above was specifically about how to list contributors to the package. I think I am the only person who has made a commit to the package who has not been listed as a contributor. I have filed a new issue for that request.

  • VIGNETTE/MANUSCRIPT: In terms of authors on the vignette and manuscript, I would suggest that we have the same authorship list on both, unless there is a clear way in which the contributions for the slightly different content are different from one another. I see the latest draft of the manuscript has this authorship "masthead"
    image
    My suggestions would be to follow something like bullet point three in the conventions listed at the link @eahowerton posted above

(3) Single consortium and individual authors in the main author list (all consortium members have
authorship status) with some of the individual authors also included within the consortium.
I note that this differs slightly from what exists currently in the manuscript, and I would suggest following these guidelines (also from @eahowerton 's doc)
image

So I think the specific to-dos here would be to

  • add everyone (including the named authors) to the consortium list
  • make the superscript on the consortium authorship not point to the list of authors, but rather say "A list of authors and their affiliations appears at the end of the paper."
  • move the actual consortium list with affiliations to the end of the manuscript

@nickreich
Copy link
Contributor Author

Noting also that I checked the JSS style guide and they had no specific guidance on consortia authorship lists.

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

No branches or pull requests

2 participants