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

Citation of DAPPER in publications #75

Open
yumengch opened this issue Jun 30, 2021 · 1 comment
Open

Citation of DAPPER in publications #75

yumengch opened this issue Jun 30, 2021 · 1 comment
Projects

Comments

@yumengch
Copy link
Contributor

Zenodo initially looks like a good way for the citation in the paper as it has a proper DOI, but it can render something a bit weird from bibtex.

I'm thinking about alternative ways to refer to DAPPER especially considering that the structure of DAPPER changes among versions, which may cause a problem without specifying the version of DAPPER in publications.

It might be good to suggest a way of citation for publications using it.

@patnr
Copy link
Collaborator

patnr commented Jun 30, 2021

This is an important point, so much so that suggested citation methods are now given at the top of the README. It says "If you use it in a publication, please cite, e.g., 'The experiments used (inspiration from) DAPPER [ref], version 1.2.1', where [ref] points to Zenodo/DOI.

I think this is good enough for the issue of versioning (one could even refer to git hashes). But yes, the Zenodo reference is not very clean. A much better solution would be publishing the docs in some way, similar to e.g.:

One drawback (also with Zenodo) is that the author list cannot change.

I see pdoc3 has a "--pdf" flag, but not a "--tex" or "--md" flag, so I'm not sure what's the best way to do it.

@patnr patnr added this to To do in v2 via automation Jun 30, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
v2
  
To do
Development

No branches or pull requests

2 participants