rdata icon indicating copy to clipboard operation
rdata copied to clipboard

Add JOSS paper.

Open vnmabus opened this issue 1 year ago • 2 comments

Describe the proposed changes

This adds a paper to the repo, so that we can submit it to JOSS.

@trossi I had to rewrite part of the text that I had, as it was for an older version (prior to pyOpenSci submission). It can probably (almost surely, I would say) be improved, in case you have suggestions to do so. Other things to take into account:

  • Please review your author info. I tried to add your ORCID and affiliation, but it may be incorrect.
  • Please add your acknowledgements (funding or whatever you need).
  • Please feel free to add the work in which you used the library at the end of the "Statement of need" section.
  • I left the section "Ongoing work" (name can be changed) for you to explain the changes you did.
  • You can compile locally using the Docker they provide (https://joss.readthedocs.io/en/latest/paper.html#docker). I also set up the Github action, to check the paper after you push (e.g. https://github.com/vnmabus/rdata/actions/runs/10648562090).

You can add your changes either as suggestions to this PR or as PRs against this branch.

vnmabus avatar Aug 31 '24 22:08 vnmabus

I agree with all your suggestions. I commit them and will re-read the article to see if more improvements need to be made. I suggest you to do the same if/when you have time.

Thank you! I added the changes related to discussion on paper.bib. I re-read the article and I think it's in good state. I can have another look later this week.

trossi avatar Sep 11 '24 12:09 trossi

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 93.98%. Comparing base (a16f99a) to head (5174536). Report is 130 commits behind head on develop.

Additional details and impacted files
@@             Coverage Diff             @@
##           develop      #43      +/-   ##
===========================================
+ Coverage    89.20%   93.98%   +4.78%     
===========================================
  Files           10       17       +7     
  Lines         1176     1629     +453     
===========================================
+ Hits          1049     1531     +482     
+ Misses         127       98      -29     
Flag Coverage Δ
93.98% <ø> (?)

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

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

codecov-commenter avatar Sep 22 '24 15:09 codecov-commenter

@trossi , I just sent the submission to JOSS.

vnmabus avatar Oct 27 '24 12:10 vnmabus

@vnmabus Great! Thank you!

trossi avatar Oct 28 '24 06:10 trossi

@trossi In case you need it for your CV: it seems that the article was fast-tracked... well, really fast 😅️: https://joss.theoj.org/papers/10.21105/joss.07540

I will merge this and make the necessary edits in the repo in the following days.

vnmabus avatar Dec 02 '24 19:12 vnmabus

@vnmabus Great, thank you!

trossi avatar Dec 04 '24 12:12 trossi