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
Compile bilbiography for analyses #547
Conversation
To add more detail as to how |
Codecov Report
@@ Coverage Diff @@
## master #547 +/- ##
==========================================
+ Coverage 84.03% 84.56% +0.52%
==========================================
Files 38 39 +1
Lines 1616 1671 +55
==========================================
+ Hits 1358 1413 +55
Misses 258 258
Continue to review full report at Codecov.
|
This is almost done. @tyarkoni @rwblair what do you think? Still need to add many more references (most glaringly for extractors). I decided to keep this info out of the db, and simply in a JSON file btw. Unfortunately, I could not get |
I modified For datasets, and tools, they always have a |
Looks great! |
Closes #543
Looks like
CSL
is a good JSON standard for citations. In a .json file, I will keep a list of citations, with keys representing eithertools
,datasets
orextractor_names
. I don't think there should ever be clashes.Then, an API endpoint will simply take a base set of tools + the dataset_name + extractor_names in an analysis, and return a
CSL-JSON
.We could additionally try using citeproc-py to render a bibliography in APA or other format. However, the python library looks a bit clunky and not actively maintained, so I'm weary of using it. Also, this limits the formats we can provide (as it would require going back and forth, and doing it only on compilation).
Instead, I think its best if we use
citations.js
, a much more actively developed library, to render / compile the bibliography. This way, users could select a format, and compile it, including BibTex or another common format.