CHOP-CGTInformatics / REDCapTidieR

Makes it easy to read REDCap Projects into R
https://chop-cgtinformatics.github.io/REDCapTidieR/
Other
33 stars 8 forks source link

[FEATURE] References Improvements #172

Closed RhysPeploe closed 8 months ago

RhysPeploe commented 8 months ago

openjournals/joss-reviews/issues/6277

When checking the references on the paper, a few things came up:

Once these are resolved my checklist for submission will be complete, thanks.

Checklist

rsh52 commented 8 months ago

Hi @RhysPeploe. Thanks for the feedback. I looked at your recommendations and have a couple of questions:

line 108/109 the URL does not work, leads to a 404 error REDCapDM

It seems that team moved the URL, I will update it to the new link.

line 104 lowercase r for the programming language, suggest capitalisation line 111 similar lowercase for redcap, suggest REDCap to be consistent

I do not see these on my end, is there any chance something is getting lost in translation?

line 126 does not include the URL for the tibble package (although the link in the text line 64 works fine)

Can you confirm this link works: https://tibble.tidyverse.org/ This is what is hyperlinked to the tibble package, and works on my end.

line 134 the url includes the " (website)" so that part needs unlinking from the hyperlink, as currently the url does not work

Apologies, it is difficult for me to follow these line numbers since they are different from what is on GitHub. I'm wondering if the capitalization issues you're seeing might be solved there as well. Which link is this in reference to?

RhysPeploe commented 8 months ago

image Hi @rsh52,
Line 104/111 shown in blue, using the generated paper pdf
Line 126 in yellow does not have the url link, it is hyperreffed correctly in the body of the paper

RhysPeploe commented 8 months ago

Regarding line 134, seems only an issue in the article proof pdf, not the proof on github, but the (website) is also hyperlinked so the url is: https://docs.ropensci.org/skimr/%20(website) Where it should be: https://docs.ropensci.org/skimr/

Hope that helps!

image

rsh52 commented 8 months ago

Ah thank you @RhysPeploe

I see these are in the bib file. The first one is odd, is there a chance this is auto-enforced by the editorial bot? I have "R" capitalized in the file:

https://github.com/CHOP-CGTInformatics/REDCapTidieR/blob/78af9f881903ddd98e705bd6fe402357e13f0609/paper/paper.bib#L52-L54

For redcapAPI this is the actual name of the package, so IMO we should leave it in this format.

I can definitely fix the tibble URL citation. 👍 I will remove the "(website)" from the skimr citation 👍

RhysPeploe commented 8 months ago

Try double parentheses {{title}}, this should retain the way you have typed the title

@Manual{redcapr_cit, title = {{REDCapR: Interaction Between R and REDCap}}, author = {Will Beasley}, year = {2023}, url = {https://ouhscbbmc.github.io/REDCapR/}, note = {https://ouhscbbmc.github.io/REDCapR/, https://github.com/OuhscBbmc/REDCapR, https://www.ouhsc.edu/bbmc/, https://project-redcap.org}, }

My bad on the package name redcapAPI, keep that the same

rsh52 commented 8 months ago

@RhysPeploe PR merged to main!

RhysPeploe commented 8 months ago

@rsh52 everything seems to be resolved - thanks!