Automate collection of papers citing BrainGlobe tools #295
Conversation
richarddushime
changed the title
richarddushime
changed the title
|
I’d love to get some feedback on the following points before moving forward: Email – Is it necessary to include the BrainGlobe email in the OpenAlex API configuration to ensure we retrieve all relevant citation data? For now, I’m mainly focusing on ensuring the data is correct. Once everything looks good, I’ll work on improving the display, adding a better layout, and implementing filters for easier navigation. Thank you |
|
Thanks @richarddushime, I'll take a look tomorrow. |
There was a problem hiding this comment.
This looks nice, thanks @richarddushime.
Could you remove the three new md files, and add the output to the publications page (https://brainglobe.info/publications.html) instead of the original list?
Output looks nice. If there's any missing info, I would just not display it, rather than print the error. I'd also not separate them into their own section.
| "https://openalex.org/W3092644694", | ||
| ] | ||
|
|
||
| pyalex.config.email = "[email protected]" |
There was a problem hiding this comment.
I don't know if we need an email or not. If we do, can it be one the core dev team have control of, e.g. [email protected]
There was a problem hiding this comment.
the email does not really impact the results instead
Helps OpenAlex contact you if your usage exceeds limits
Usage statistics and Lets them notify users about API issues
According to what I understand in the documentation
There was a problem hiding this comment.
Cool. Could you set it to [email protected] then?
Co-authored-by: Adam Tyson <[email protected]>
…/brainglobe.github.io into citing_BrainGlobe
Alright , |
Before submitting a pull request (PR), please read the contributing guide.
Please fill out as much of this template as you can, but if you have any problems or questions, just leave a comment and we will help out :)
Description
What is this PR
Why is this PR needed?
This PR automates the collection of publications citing BrainGlobe tools using the OpenAlex API, replacing the semi-automatic process.
What does this PR do?
Implements a script that fetches citations to BrainGlobe-related works using OpenAlex.
Eliminates the need for manual updates by generating publications.md file dynamically.
References
Closes #293
Inspired by similar work done by @niksirbi.
How has this PR been tested?
I tested locally to confirm that it fetches citing publications correctly.
File output (pub_citations.md)
Is this a breaking change?
No
Does this PR require an update to the documentation?
If any features have changed, or have been added. Please explain how the documentation has been updated (and link to the associated PR). See here for details.
Checklist: