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 Allen Institute references to README + doc-string #49

Closed
rmarkello opened this issue Jun 20, 2019 · 3 comments
Closed

Add Allen Institute references to README + doc-string #49

rmarkello opened this issue Jun 20, 2019 · 3 comments
Labels
documentation Relates to updating documentation good first issue Good for newcomers help wanted Extra attention is needed

Comments

@rmarkello
Copy link
Owner

The issue

The Allen Institute has some citation policies that we should probably do a better job highlighting throughout our documentation and codebase!

Proposed solution

As it applies to the current toolbox, we should add the following publication to all Acknowledgments and References sections:

Hawrylycz, M.J. et al. (2012) An anatomically comprehensive atlas of the adult
human transcriptome, Nature 489: 391-399. doi:10.1038/nature11405

Furthermore, we should probably add a disclaimer in the License Information section of the README that all the data obtained from calling abagen.fetch_microarray() is copyrighted by Allen Institute. Adding the following would be a good start:

All microarray expression data is copyrighted under [non-commercial reuse
policies] (http://alleninstitute.org/legal/terms-use/) by the Allen Institute
for Brain Science (© 2010 Allen Institute for Brain Science. Allen Human Brain
Atlas. Available from: human.brain-map.org).
@rmarkello rmarkello added documentation Relates to updating documentation good first issue Good for newcomers help wanted Extra attention is needed labels Jun 20, 2019
@JamesFrierson1
Copy link
Contributor

Hi @rmarkello I'd be happy to contribute! I can add an additional direction in the Acknowledgments section of the README that states contributors should include the proper citation provided per The Allen Institute's policy.

And I can add the disclaimer you wrote into the License Information section as well.

Is this what you're looking for? Thanks!

@rmarkello
Copy link
Owner Author

Hi @JamesFrierson1 ! That would be awesome ! 🙌

I realize now that the text I wrote to add to the License Information is formatted in Markdown but would need to be updated to reStructuredText for the README. All that should mean is changing the format of the hyperlink, but let me know if you have any questions about that!

@rmarkello
Copy link
Owner Author

Closed with #57!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Relates to updating documentation good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants