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

Citing the package #21

Open
omarelgarwany opened this issue Mar 28, 2023 · 1 comment
Open

Citing the package #21

omarelgarwany opened this issue Mar 28, 2023 · 1 comment

Comments

@omarelgarwany
Copy link

Hi

I used the umap package in one of my analyses, but I was unsure how to cite it in my manuscript? Should I just cite the UMAP paper on aRxiv?

Thanks

@tkonopka
Copy link
Owner

Thanks for asking. Yes, citations should go to the original authors. The umap-learn repository lists recommendations here. In brief, you can cite the manuscript on arxiv or the paper in JOSS.

Of course, if you find this R package useful, it would be very nice to credit that as well. There is no formal publication, but you can cite it as an R package (see citation("umap")). An advantage of citing the software (as opposed to a manuscript) is that it makes clear what version you've used. But customs in this regard vary across disciplines, even across journals and institutions within one discipline. If you are at all constrained by number of references, do give preference to the original authors.

In case you run analyses and produce reports with Rmarkdown, you can consider including that as an appendix/supplement to a publication and including a sessionInfo() at the end. That would credit all the packages in the analysis, including base R, the dependencies this package uses, and any others.

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

No branches or pull requests

2 participants