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

Document first authors #8

Merged
merged 8 commits into from
Mar 12, 2024
Merged

Document first authors #8

merged 8 commits into from
Mar 12, 2024

Conversation

dewittpe
Copy link
Collaborator

@dewittpe dewittpe commented Mar 2, 2024

@tdbennett, I've added notes for equal contribution for you and Nelson, along with a similar not for Seth and I. Please review.

There is one exception. I didn't add any note within the Description section of the DESCRIPTION file. To add the note there I would think a parenthetical would be better than just astriks.

I've opted to use the term "contributed equally" instead of co-first-author or co-second-author to be consistent with the language used by JAMA.

…utions between Sanchez-Pinto and Bennet; DeWitt and Russell.

Prior to this change all the references where just copied from the "Cite
This" provided on the JAMA website.

This change add Russell explicitly and asstricks and a note about the
contributions.  The language is copied form the JAMA paper as well.

There is one exception - the DESCRIPTION file does not have these
indicators for contribution levels.

re #7
@dewittpe dewittpe requested a review from tdbennett March 2, 2024 01:41
@dewittpe dewittpe assigned dewittpe and tdbennett and unassigned dewittpe Mar 2, 2024
Copy link

codecov bot commented Mar 2, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (3471bd0) to head (c8ae069).

❗ Current head c8ae069 differs from pull request most recent head 0c159de. Consider uploading reports for the commit 0c159de to get more accurate results

Additional details and impacted files
@@            Coverage Diff            @@
##              main        #8   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           10        10           
  Lines          176       176           
=========================================
  Hits           176       176           
Flag Coverage Δ
examples 76.70% <ø> (ø)
tests 100.00% <ø> (ø)
total 100.00% <ø> (ø)
vignettes 76.70% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@tdbennett
Copy link
Collaborator

Hi Peter - it looks like the mentions of the manuscripts in the README still need to be updated. thanks

@dewittpe
Copy link
Collaborator Author

dewittpe commented Mar 4, 2024

@tdbennett I've added asterisks to our names in the README

@@ -15,9 +15,11 @@
Implementation of the Phoenix and Phoenix-8 Sepsis Criteria as
described in:

* ["Development and Validation of the Phoenix Criteria for Pediatric Sepsis and Septic Shock"](doi:10.1001/jama.2024.0196) by Sanchez-Pinto, Bennett, DeWitt, Russell et.al. (2024)
* ["Development and Validation of the Phoenix Criteria for Pediatric Sepsis and Septic Shock"](doi:10.1001/jama.2024.0196) by Sanchez-Pinto&ast;, Bennett&ast;, DeWitt&ast;&ast;, Russell&ast;&ast; et al. (2024)
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

@tdbennett this should render well. I used the html code &ast; to avoid markdown formatting conflicts

@dewittpe dewittpe mentioned this pull request Mar 4, 2024
@dewittpe dewittpe added the documentation Improvements or additions to documentation label Mar 11, 2024
dewittpe and others added 2 commits March 11, 2024 14:19
Refactor how the two JAMA papers are cited - all the authors and equal
contribution notes are in the phoenix-package documentation with links
and directions to review the details there in all the other function
manual files.   The CITATION file as been extended to include notes on
the two JAMA papers and instructions on how to cite the R package.

re #7, #8
@dewittpe dewittpe merged commit 248a4df into main Mar 12, 2024
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants