lisphilar / covid19-sir

CovsirPhy: Python library for COVID-19 analysis with phase-dependent SIR-derived ODE models.
https://lisphilar.github.io/covid19-sir/
Apache License 2.0
109 stars 44 forks source link

[Docs] BibTex Format Citation Request #1764

Closed EnzeXu closed 1 month ago

EnzeXu commented 1 month ago

Checkbox

Suggested improvement of documentation

I appreciate the dataset you’ve made available. It’s been extremely helpful for my work! However, I noticed that the repository lacks a BibTeX citation format, which would make it much easier to reference in academic publications. I understand there is no original published paper related to your dataset. However, you may create a website or github_repo reference like: @misc{website_name, author = {Author or Organization Name}, title = {Title of the Website or Page}, year = {Year of Publication or Last Update}, url = {https://www.example.com}, note = {Accessed: YYYY-MM-DD} }

or

@misc{github_repo, author = {Repository Author or Organization}, title = {Repository Title}, year = {Year of Publication or Last Update}, url = {https://github.com/username/repository}, note = {Accessed: YYYY-MM-DD} }

And then you may add this BibTeX citation to the README. Thank you for your time and consideration!

lisphilar commented 1 month ago

@EnzeXu, Thank you for using CovsirPhy and/or COVID-19 dataset for Japan. Before add the format citation to documentation, followings will be help you.

CovsirPhy

@misc{github_repo,
author = {Hirokazu Takaya and CovsirPhy Development Team},
title = {CovsirPhy version [version number]: Python library for COVID-19 analysis with phase-dependent SIR-derived ODE models},
year = {2020},
url = {https://github.com/lisphilar/covid19-sir},
note = {Accessed: YYYY-MM-DD}
}

COVID-19 dataset in Japan

@misc{github_repo,
author = {Hirokazu Takaya},
title = {COVID-19 dataset in Japan},
year = {2020},
url = {https://github.com/lisphilar/covid19-sir/data/japan},
note = {Accessed: YYYY-MM-DD}
}

Editted to replace ")" with "}" in url line.

EnzeXu commented 1 month ago

@lisphilar Thank you very much for the information. We will reference CovsirPhy in our paper, as we’re not using the Japan dataset. Have a great week!

lisphilar commented 1 month ago

(I fixed minor errors on my previous comment and add the citations to documentation with https://github.com/lisphilar/covid19-sir/pull/1765.)

EnzeXu commented 1 month ago

Sounds great! Thank you!