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

Add two versions of citations: for the package and (if relevant) for JOSS paper #319

Open
IndrajeetPatil opened this issue Oct 26, 2022 · 8 comments
Assignees
Labels
Beginner-friendly 🤝 Friendly for new contributors

Comments

@IndrajeetPatil
Copy link
Member

IndrajeetPatil commented Oct 26, 2022

{correlation} now provides two possible ways to cite the package (introduced in easystats/correlation#271):

  • R package version
  • JOSS paper version
citation("correlation")
#> 
#> To cite package 'correlation' in publications use:
#> 
#>   Makowski, D., Wiernik, B. M., Patil, I., Lüdecke, D., & Ben-Shachar,
#>   M. S. (2022). correlation: Methods for correlation analysis (0.8.3)
#>   [R package]. https://CRAN.R-project.org/package=correlation (Original
#>   work published 2020)
#> 
#>   Makowski, D., Ben-Shachar, M. S., Patil, I., & Lüdecke, D. (2019).
#>   Methods and algorithms for correlation analysis in R. Journal of Open
#>   Source Software, 5(51), 2306. https://doi.org/10.21105/joss.02306
#> 
#> To see these entries in BibTeX format, use 'print(<citation>,
#> bibtex=TRUE)', 'toBibtex(.)', or set
#> 'options(citation.bibtex.max=999)'.

Created on 2022-10-26 with reprex v2.0.2

Should we be doing this for other packages as well? Especially for packages where the current authors are not part of the original paper?

citation("insight")
#> 
#> To cite package 'insight' in publications use:
#> 
#>   Lüdecke D, Waggoner P, Makowski D (2019). "insight: A Unified
#>   Interface to Access Information from Model Objects in R." _Journal of
#>   Open Source Software_, *4*(38), 1412. doi:10.21105/joss.01412
#>   <https://doi.org/10.21105/joss.01412>.
#> 
#> A BibTeX entry for LaTeX users is
#> 
#>   @Article{,
#>     title = {{insight}: A Unified Interface to Access Information from Model Objects in {R}.},
#>     volume = {4},
#>     doi = {10.21105/joss.01412},
#>     number = {38},
#>     journal = {Journal of Open Source Software},
#>     author = {Daniel Lüdecke and Philip Waggoner and Dominique Makowski},
#>     year = {2019},
#>     pages = {1412},
#>   }

citation("effectsize")
#> 
#> To cite effectsize in publications use:
#> 
#>   Ben-Shachar M, Lüdecke D, Makowski D (2020). effectsize: Estimation
#>   of Effect Size Indices and Standardized Parameters. Journal of Open
#>   Source Software, 5(56), 2815. doi: 10.21105/joss.02815
#> 
#> A BibTeX entry for LaTeX users is
#> 
#>   @Article{,
#>     title = {{e}ffectsize: Estimation of Effect Size Indices and Standardized Parameters},
#>     author = {Mattan S. Ben-Shachar and Daniel Lüdecke and Dominique Makowski},
#>     year = {2020},
#>     journal = {Journal of Open Source Software},
#>     volume = {5},
#>     number = {56},
#>     pages = {2815},
#>     publisher = {The Open Journal},
#>     doi = {10.21105/joss.02815},
#>     url = {https://doi.org/10.21105/joss.02815},
#>   }

Created on 2022-10-26 with reprex v2.0.2

@DominiqueMakowski
Copy link
Member

@easystats/core-team

@DominiqueMakowski
Copy link
Member

I think it's already the case in report::cite_easystats()

@IndrajeetPatil
Copy link
Member Author

But users most likely don't run report::cite_easystats().
They will run citation() for whatever easystats package they have been using in their workflow.

@DominiqueMakowski
Copy link
Member

aggreed, I was mentioning that because we should probably harmonize across both

@bwiernik
Copy link
Contributor

It was on my todo list to update the other package citations too

@IndrajeetPatil
Copy link
Member Author

That'll be awesome, thanks!

@IndrajeetPatil IndrajeetPatil added Beginner-friendly 🤝 Friendly for new contributors and removed Discussion 🦜 labels Oct 28, 2022
@IndrajeetPatil IndrajeetPatil changed the title Should we have two versions of citations for all packages? Add two versions of citations: for the package and (if relevant) for JOSS paper Oct 28, 2022
@IndrajeetPatil
Copy link
Member Author

bump

@bwiernik
Copy link
Contributor

Oh oops. On it

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Beginner-friendly 🤝 Friendly for new contributors
Projects
None yet
Development

No branches or pull requests

3 participants