Skip to content

Commit

Permalink
Add citation info in readme and docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
vnmabus committed Jan 25, 2025
1 parent ed74e13 commit 486720f
Show file tree
Hide file tree
Showing 3 changed files with 71 additions and 1 deletion.
37 changes: 36 additions & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ rdata

|build-status| |docs| |coverage| |repostatus| |versions| |pypi| |conda| |zenodo| |pyOpenSci|

Read R datasets from Python.
A Python library for R datasets.

..
Github does not support include in README for dubious security reasons, so
Expand Down Expand Up @@ -66,6 +66,41 @@ Examples

Examples of use are available in
`ReadTheDocs <https://rdata.readthedocs.io/en/stable/auto_examples/>`__.

Citing rdata
============

Please, if you find this software useful in your work, reference it citing the following paper:

.. code-block::
@article{ramos-carreno+rossi_2024_rdata,
author = {Ramos-Carreño, Carlos and Rossi, Tuomas},
doi = {10.21105/joss.07540},
journal = {Journal of Open Source Software},
month = dec,
number = {104},
pages = {1--4},
title = {{rdata: A Python library for R datasets}},
url = {https://joss.theoj.org/papers/10.21105/joss.07540#},
volume = {9},
year = {2024}
}

You can additionally cite the software repository itself using:

.. code-block::
@misc{ramos-carreno++_2024_rdata-repo,
author = {The rdata developers},
doi = {10.5281/zenodo.6382237},
month = dec,
title = {rdata: A Python library for R datasets},
url = {https://github.com/vnmabus/rdata},
year = {2024}
}
If you want to reference a particular version for reproducibility, check the version-specific DOIs available in Zenodo.

Simple usage
============
Expand Down
34 changes: 34 additions & 0 deletions docs/citing.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
Citing rdata
============

Please, if you find this software useful in your work, reference it citing the following paper:

.. code-block::
@article{ramos-carreno+rossi_2024_rdata,
author = {Ramos-Carreño, Carlos and Rossi, Tuomas},
doi = {10.21105/joss.07540},
journal = {Journal of Open Source Software},
month = dec,
number = {104},
pages = {1--4},
title = {{rdata: A Python library for R datasets}},
url = {https://joss.theoj.org/papers/10.21105/joss.07540#},
volume = {9},
year = {2024}
}

You can additionally cite the software repository itself using:

.. code-block::
@misc{ramos-carreno++_2024_rdata-repo,
author = {The rdata developers},
doi = {10.5281/zenodo.6382237},
month = dec,
title = {rdata: A Python library for R datasets},
url = {https://github.com/vnmabus/rdata},
year = {2024}
}
If you want to reference a particular version for reproducibility, check the version-specific DOIs available in Zenodo.
1 change: 1 addition & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ Its main advantages are:
auto_examples/index
Try online! <https://rdata.readthedocs.io/en/latest/lite/lab/?path=auto_examples/plot_example.ipynb>
conversions
citing
contributors

The package rdata is developed `on Github <http://github.com/vnmabus/rdata>`_.
Expand Down

0 comments on commit 486720f

Please sign in to comment.