Document metadata for tools

[tetron]

Essential:

• Author
• Description

Others:

• Topic (keywords?)
• License of wrapped tool (Must described tools be under an F/OSS license and have a container already? #4)

See https://github.com/Barski-lab/workflows/blob/master/tools/bamtools-stats.cwl for ideas

[mr-c]

Other option: include links to existing repositories like https://bio.tools/ https://scicrunch.org/

As they will have all of this metadata already.

[mr-c]

These links can go to under the SoftwareRequirement along with the targeted versions

[michael-kotliar]

I guess, we should separate metadata related to the CWL descriptor file and metadata of the dockerized program.
For metadata of the CWL descriptor file we can use this

$namespaces:
  s: http://schema.org/

$schemas:
- http://schema.org/docs/schema_org_rdfa.html

s:name: "fastqc"
s:downloadUrl: https://raw.githubusercontent.com/Barski-lab/workflows/master/tools/fastqc.cwl
s:codeRepository: https://github.com/Barski-lab/workflows
s:license: http://www.apache.org/licenses/LICENSE-2.0

s:isPartOf:
  class: s:CreativeWork
  s:name: Common Workflow Language
  s:url: http://commonwl.org/

s:creator:
- class: s:Organization
  s:legalName: "Cincinnati Children's Hospital Medical Center"
  s:location:
  - class: s:PostalAddress
    s:addressCountry: "USA"
    s:addressLocality: "Cincinnati"
    s:addressRegion: "OH"
    s:postalCode: "45229"
    s:streetAddress: "3333 Burnet Ave"
    s:telephone: "+1(513)636-4200"
  s:logo: "https://www.cincinnatichildrens.org/-/media/cincinnati%20childrens/global%20shared/childrens-logo-new.png"
  s:department:
  - class: s:Organization
    s:legalName: "Allergy and Immunology"
    s:department:
    - class: s:Organization
      s:legalName: "Barski Research Lab"
      s:member:
      - class: s:Person
        s:name: Michael Kotliar
        s:email: mailto:[email protected]
        s:sameAs:
        - id: http://orcid.org/0000-0002-6486-3898

doc: "Information about how to run this CWL tool - which parameters are implemented, which parameters are skipped, which functions defined, what outputs to expect, etc."
s:about: "Copy of the --help message from the program"

[KerstenBreuer]

I really like this shema. If the others agree, maybe we should propose to use the most essential fields (and the doc) in the Readme?