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

[MRG] update JOSS paper for v4 #1361

Merged
merged 37 commits into from
Aug 16, 2023
Merged

[MRG] update JOSS paper for v4 #1361

merged 37 commits into from
Aug 16, 2023

Conversation

ctb
Copy link
Contributor

@ctb ctb commented Mar 4, 2021

Per openjournals/joss#423, we are planning to make a new submission to JOSS for sourmash v4.x. The first paper from 2016 is here.

Fixes #1321.

Ref #622, #444.

@codecov
Copy link

codecov bot commented Mar 4, 2021

Codecov Report

Merging #1361 (88dcbd9) into latest (c35cc19) will increase coverage by 7.55%.
Report is 1 commits behind head on latest.
The diff coverage is n/a.

❗ Current head 88dcbd9 differs from pull request most recent head d7e6cdd. Consider uploading reports for the commit d7e6cdd to get more accurate results

@@            Coverage Diff             @@
##           latest    #1361      +/-   ##
==========================================
+ Coverage   85.27%   92.83%   +7.55%     
==========================================
  Files         133      104      -29     
  Lines       15191    12389    -2802     
  Branches     2614     2612       -2     
==========================================
- Hits        12954    11501    -1453     
+ Misses       1936      587    -1349     
  Partials      301      301              
Flag Coverage Δ
hypothesis-py 25.81% <ø> (+<0.01%) ⬆️
python 92.83% <ø> (-0.01%) ⬇️
rust ?

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

see 32 files with indirect coverage changes

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

@ctb
Copy link
Contributor Author

ctb commented Apr 21, 2021

Does anyone have any comments on the text? @luizirber @bluegenes in particular.

Also, I can't figure out how to get the references to work properly using https://whedon.theoj.org/, but 🤷

paper.md Show resolved Hide resolved
paper.md Outdated Show resolved Hide resolved
paper.md Outdated Show resolved Hide resolved
paper.md Outdated Show resolved Hide resolved
Copy link
Contributor

@bluegenes bluegenes left a comment

Choose a reason for hiding this comment

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

Made some suggestions. Otherwise looks good to me!

@ctb ctb mentioned this pull request May 6, 2021
14 tasks
@ctb
Copy link
Contributor Author

ctb commented May 6, 2021

@luizirber if there aren't any concerns on your part, I'll update the authors one more time and submit to JOSS in the next week or two.

@ctb ctb changed the title [WIP] update JOSS paper for v4 [MRG] update JOSS paper for v4 May 15, 2021
@ctb ctb changed the title [MRG] update JOSS paper for v4 [WIP] update JOSS paper for v4 May 15, 2021
@bluegenes
Copy link
Contributor

bluegenes commented Apr 27, 2022

@ctb @luizirber I'd like to update this further for ANI (adding David and Mahmudur + some ANI text), and then submit to JOSS (after 4.4 is out).

I assume there are some other authors we may also need to add or author ordering to change, given the time since this was updated - @ctb is this something you could help with or guide me through?

@ctb
Copy link
Contributor Author

ctb commented Jan 3, 2023

Main thing remaining to be done: fix all the missing information in the authors (search for @@@ in paper.md)

@ctb
Copy link
Contributor Author

ctb commented Jan 3, 2023

@bluegenes I think we should pull in CITATION.cff and maybe codemeta.json from #837 and update them on this PR; seem good? I can do some light editing if you can proof :)

@luizirber
Copy link
Member

luizirber commented Jan 4, 2023

Main thing remaining to be done: fix all the missing information in the authors (search for @@@ in paper.md)

@bluegenes I think we should pull in CITATION.cff and maybe codemeta.json from #837 and update them on this PR; seem good? I can do some light editing if you can proof :)

I think the author list in pyproject.toml is the most updated (with all the ORCID): https://github.com/sourmash-bio/sourmash/blob/059d98853b0b390c9d69832f132e0812be70448c/pyproject.toml#L14L49

@bluegenes
Copy link
Contributor

Hi coauthors,

We're getting ready to submit this to JOSS! Can you please review your information and the manuscript text and provide any comments by April 21st?

shortcut to files changed: https://github.com/sourmash-bio/sourmash/pull/1361/files
rendered pdf attached here.
paper.pdf

@luizirber @mr-eyes @halexand @itsabhianant @keyabarve @ccbaumler @olgabot @brooksph @dsouzadaniel @lgautier @mahmudhera @hehouts @johnsolk @kloetzl @dkoslicki @marisalim @ricky-lim @xmnlab @taylorreiter @camillescott @druvus @standage @swamidass @connor-reid-tiffany @pranathivemuri @erikyoung85 @ctb

@mr-eyes
Copy link
Member

mr-eyes commented Mar 30, 2023

Everything sounds great to me.

@xmnlab
Copy link
Contributor

xmnlab commented Mar 31, 2023

just a question, I was listed without a affiliation: https://github.com/sourmash-bio/sourmash/pull/1361/files#diff-0403ef06adf405f7b310b4518bd6a3559854f54c61676f676ce9cbfee7172ab6R64
but in the pdf rendered shows affiliation 1 ... is that expected?

@bluegenes
Copy link
Contributor

just a question, I was listed without a affiliation: https://github.com/sourmash-bio/sourmash/pull/1361/files#diff-0403ef06adf405f7b310b4518bd6a3559854f54c61676f676ce9cbfee7172ab6R64 but in the pdf rendered shows affiliation 1 ... is that expected?

Thanks for catching that -- unexpected. Here's the updated version

paper.pdf

@xmnlab
Copy link
Contributor

xmnlab commented Mar 31, 2023

Thanks for catching that -- unexpected. Here's the updated version

paper.pdf

thanks @bluegenes ! thanks look good to me :)

@bluegenes
Copy link
Contributor

updated @marisalim @johnsolk to UC Davis affil to reflect time of work

paper.pdf

@swamidass
Copy link
Contributor

Thanks for including me. This is seems more like an abstract than a paper. But that isn't necessarily a problem for JOSS.

My affiliation is: Associate Professor, Laboratory and Genomic Medicine, Washington University in St Louis

If there is a full scientific paper written at some point, there are some additional algorithms to consider benchmarking. Please reach out to me early enough on so that I can help with the design.

@bluegenes
Copy link
Contributor

bluegenes commented Apr 4, 2023

Thanks for including me. This is seems more like an abstract than a paper. But that isn't necessarily a problem for JOSS.

My affiliation is: Associate Professor, Laboratory and Genomic Medicine, Washington University in St Louis

If there is a full scientific paper written at some point, there are some additional algorithms to consider benchmarking. Please reach out to me early enough on so that I can help with the design.

Hi @swamidass,

Yes - the goal here is an updated general citation for the software. If you're interested in our larger paper efforts, please see our 2022 preprint, Lightweight compositional analysis of metagenomes with FracMinHash and minimum metagenome covers and our 2019 use cases paper, Large-scale sequence comparisons with sourmash.

We would welcome any additional contributions or discussion on the issue tracker!

I will add your affiliation here.

thanks!

updated pdf: paper.pdf

@taylorreiter
Copy link
Contributor

looks good to me!

@mahmudhera
Copy link

Looks good. Thanks!

@connor-reid-tiffany
Copy link
Contributor

connor-reid-tiffany commented Apr 6, 2023 via email

@dkoslicki
Copy link
Collaborator

Looks good to me as well!

paper.md Outdated
affiliations:
- name: University of California, Davis
index: 1
- name: Woods Hole Oceanographic Institute
Copy link
Contributor

Choose a reason for hiding this comment

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

Lokos good-- but should be Institution

Copy link
Contributor

Choose a reason for hiding this comment

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

😂 I should have caught this - happens with Scripps all the time. Will fix!

@standage
Copy link
Contributor

Hi @bluegenes, could we add the following (not super relevant but unfortunately still required) statement to the acknowledgements?

Notice: This manuscript has been authored by BNBI under Contract
No. HSHQDC-15-C-00064 with the DHS. The US Government retains
and the publisher, by accepting the article for publication, acknowledges
that the USG retains a non-exclusive, paid-up, irrevocable, world-wide
license to publish or reproduce the published form of this manuscript,
or allow others to do so, for USG purposes. Views and conclusions
contained herein are those of the authors and should not be interpreted
to represent policies, expressed or implied, of the DHS.

@bluegenes bluegenes changed the title [WIP] update JOSS paper for v4 [MRG] update JOSS paper for v4 Aug 16, 2023
@bluegenes
Copy link
Contributor

@ctb ready for review and merge

Let's revisit making citation guidelines clearer after pyopensci review?

@ctb ctb merged commit 6c28366 into latest Aug 16, 2023
19 checks passed
@ctb ctb deleted the update/joss branch August 16, 2023 00:58
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.

prepare JOSS paper for sourmash 4.0 release?