Documentation: Overview

Documentation

The Documentation Wiki entries are brief 1-page introductions to each of the major components of our openVirus system. Each will contain the rationale, how to install/ use and interpret.

software template

getpapers

Ferret

ami makeproject pdfbox search section

indexing (Solr)

ContentMine dictionaries (ami dictionary)

data display (R)

==== software template ====

where appropriate record your experience.

name

name, primary URL

purpose

documentation.

Link to docs (record: ease of use)

installation

(note platform: Unix, MacOSX, Windows (version, any) (record: ease of installation, problems, preconditions). languages? libraries?

example of use

(link to Github page with full details: input, console log, major files)

comments

(readiness for use, stability)

---

sources supported

EuropePMC (via getpapers)

biorxiv and medrxiv via Ferret or ami download

Wikidata (via ami dictionary)

BL Ethos

DOAJ

==== source Template ====

name

primary URL, contact address?

primary content

documentation,

tutorials (links), mailing lists? Wiki? Github

access

(download? server? )

update

policy.

restrictions

tool/s for access

content type

(format, encoding)

integration with CProject?

cleaning/transformation required?

---

==== Frameworks/infrastructure ----

commandline

Docker

KN1ME