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 references based on DOIs #9

Open
dalonsoa opened this issue Aug 26, 2020 · 2 comments
Open

Add references based on DOIs #9

dalonsoa opened this issue Aug 26, 2020 · 2 comments
Assignees

Comments

@dalonsoa
Copy link
Collaborator

dalonsoa commented Aug 26, 2020

A more robust alternative will be to include the reference using just the DOI, for example:

@add_reference(short_purpose="Original implementation of R2T2", doi="10.5281/zenodo.1185316")
def my_great_function():
    pass

And then retrieve the complete data online (for example, using a tool like this). This approach requires internet connnection but this could be sorted out if the data is retrieved just once - possibly by the developer of the code - and then the reference information cached in a file shipped together with the code (see #10 and #11).

@dalonsoa dalonsoa changed the title Add references absed on DOIs Add references based on DOIs Aug 26, 2020
@rgaiacs
Copy link
Contributor

rgaiacs commented Sep 1, 2020

I vote to add_reference have only two parameters: purpose and doi. And we fetch the data using doi2bib as suggested. I strong recommend that we cache the references but I suggest that we accept as universal true that the user has internet connection.

@dalonsoa
Copy link
Collaborator Author

dalonsoa commented Sep 2, 2020

Having internet connection is most likely the case, I fully agree. However, I don't see any reason to impose that requirement in the user (beyond the installation phase, of course) - specially if the information is going to be cached anyway.

In any case, purpose + doi is my preferred option, too 🙂

@dalonsoa dalonsoa self-assigned this Sep 2, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants