carnival-data / carnival

JVM property graph data unification framework

Home Page:https://carnival-data.github.io/carnival/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Address documentation comments from Chris S

augustearth opened this issue · comments

Summary:

  • Regarding related systems, “there are comparatively fewer compelling informatics offerings to address these concerns.” Only need one if it does the job. What are the limitations of the other offerings that makes Carnival worth using instead? We don’t have to mention the other offering but I’m curious what others you had in mind.
  • Carnival provides more than “tools to go from source data to a well formatted property graph and onward to RDF.” Should there be mention of clean up and provenance here? Swap this sentence with Statement of need?

Statement of need:
Reads well! As indicated above consider swapping the opening sentence on Carnival with the closing sentence on Carnival from the Summary section.
In the Queries over enriched data, can cite the MedInfo paper and the Semantic Engine paper in J Biomed Inform.

Comparison to JOSS requirements:
The JOSS example Gala paper is just one paragraph for Summary and 2 paragraphs for Statement of need. I think we have plenty for that. They do mention figures and citations so those are still to be done.
For citations of use we can include the MedInfo paper and the Semantic Engine paper in J Biomed Inform as mentioned above.

Concerns have been addressed.