diff --git a/README.rst b/README.rst index 3a0810b..739e1a5 100644 --- a/README.rst +++ b/README.rst @@ -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 @@ -66,6 +66,41 @@ Examples Examples of use are available in `ReadTheDocs `__. + +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 ============ diff --git a/docs/citing.rst b/docs/citing.rst new file mode 100644 index 0000000..b8513e9 --- /dev/null +++ b/docs/citing.rst @@ -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. diff --git a/docs/index.rst b/docs/index.rst index 75eafcf..9fa4be2 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -34,6 +34,7 @@ Its main advantages are: auto_examples/index Try online! conversions + citing contributors The package rdata is developed `on Github `_.