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

Should duecredit be a required or optional dependency? #253

Closed
tsalo opened this issue Jun 17, 2020 · 5 comments
Closed

Should duecredit be a required or optional dependency? #253

tsalo opened this issue Jun 17, 2020 · 5 comments
Labels
Discussion Discussion of a concept or implementation. Need to stay always open.

Comments

@tsalo
Copy link
Member

tsalo commented Jun 17, 2020

Summary

#249 sets duecredit up as an optional dependency, but the devs should decide whether they want it as an optional or required dependency.

duecredit is a package for associating citations with code. The developer add decorators to functions with the appropriate citations for those functions. Then, when the users runs the code, they can use a duecredit command to collect all citations for all functions run, and get an annotated bibliography that they can incorporate into their manuscript.

Additional detail

This stems from #249 (review).

Next Steps

  • Discuss
@tsalo
Copy link
Member Author

tsalo commented Jun 17, 2020

I vote optional, FWIW. That's how we do it in tedana and NiMARE. The drawback is that making it an optional dependency means we need to include the due.py stub file in the repository to prevent import errors.

@smoia
Copy link
Member

smoia commented Jun 17, 2020

@tsalo , could you explain a bit more what is duecredit and why we should be using it? I'm not sure all of the physiopy developers know what it is!

@smoia smoia added the Discussion Discussion of a concept or implementation. Need to stay always open. label Jun 17, 2020
@eurunuela
Copy link
Collaborator

Optional sounds good to me!

@tsalo
Copy link
Member Author

tsalo commented Jun 18, 2020

@smoia I updated the issue summary. Thanks for catching that.

@smoia
Copy link
Member

smoia commented Jul 30, 2020

I guess optional it is!
I'll close this since it's the current setup.

@smoia smoia closed this as completed Jul 30, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Discussion Discussion of a concept or implementation. Need to stay always open.
Projects
None yet
Development

No branches or pull requests

3 participants