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

Extracting and cross-referencing figures in repo code and paper #6

Open
krassowski opened this issue Oct 4, 2021 · 0 comments
Open

Comments

@krassowski
Copy link
Collaborator

Just a general thought: I think what could be an interesting angle specific to academic papers is to focus on the figures as the scientific output. I.e., the main task of the tool would be to figure out what figures of the paper can be recreated using the repository and how. It would also be cool to not only take into account the code itself but also additional information that might be present in a README file, or even in the publication itself.

Originally posted by @mstimberg in #1 (comment)

Building upon this one I can envision a semi-automated tool which when matching a regular expression/substring from figure caption, for simplicity say "Figure 1" in the code will compare it with the article text and opens a dismissible suggestion in a sidebar:

It seems that [lines X-Y] in file Z.py reference Figure 1. [Description]. Is this correct?

Yes | Edit (modify exact location) | No (dismiss)

When confirmed by the user the data would be stored into a config file allowing to avoid repeating this on subsequent visits (if the config gets committed to that repository; we could be even make a bot create a PR on user request), and more importantly the figure would show in the flow visualisation of the repo, and when browsing code (on the sidebar) - assuming that we would add code browsing option, which would not be that difficult but probably outside of Sprint scope.

I also commented in the previous discussion that supplementary tables could get this treatment too.

@krassowski krassowski changed the title Extracting cross-referencing figures in repo and code Extracting and cross-referencing figures in repo code and paper Oct 4, 2021
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

1 participant