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

User testing - helpful workflow metadata fields #7

Open
6 of 38 tasks
atrisovic opened this issue May 26, 2022 · 0 comments
Open
6 of 38 tasks

User testing - helpful workflow metadata fields #7

atrisovic opened this issue May 26, 2022 · 0 comments

Comments

@atrisovic
Copy link
Member

atrisovic commented May 26, 2022

Users are to be asked to check out helpful metadata fields - both for documenting their own workflow and understanding others' workflows.

Part I & II: Bioschema recommended

  • dateCreated - The date on which the CreativeWork was created.
  • input - An input required to use the computational workflow (eg. Excel spreadsheet, BAM file)
  • license - A license document that applies to this content, typically indicated by URL.
  • name - The name of the item.
  • output - An output produced by the workflow.
  • programmingLanguage - The computer programming language.
  • sdPublisher - Indicates the party responsible for generating and publishing the current structured data markup, typically in cases where the structured data is derived automatically from existing published content but published on a different site.
  • url - URL of the item.
  • version - The version of the CreativeWork embodied by a specified resource.
  • citation - A citation or reference to another creative work, such as another publication, web page, scholarly article, etc.
  • contributor - A secondary contributor to the CreativeWork or Event.
  • creativeWorkStatus - The status of a creative work in terms of its stage in a lifecycle (eg. Incomplete, Draft, Published, Obsolete).
  • description - A description of the item.
  • documentation - Documentation describing the ComputationalWorkflow and its use.
  • funding - The funding for the workflow.
  • hasPart - Indicates an item or CreativeWork that is part of this item, or CreativeWork (in some sense).
  • isBasedOn - A resource from which this work is derived or from which it is a modification or adaption (eg. another ComputationalWorkflow, a paper or a lab protocol).
  • keywords - Keywords or tags used to describe this content. Multiple entries in a keywords list are typically delimited by commas.
  • maintainer - A maintainer of a Dataset, software package (SoftwareApplication), or other Project.
  • producer - The person or organization who produced the workflow.
  • publisher - The publisher of the creative work (e.g. Galaxy, GitHub, or WF Hub).
  • runtimePlatform - Runtime platform or script interpreter dependencies (eg. Java v1, Python 2.3, .Net Framework 3.0).
  • softwareRequirements - Component dependency requirements for application. This includes runtime environments and shared libraries that are not included in the application distribution package, but required to run the application (eg. DirectX, Java or .NET runtime).
  • targetProduct - Target Operating System / Product to which the code applies. If applies to several versions, just the product name can be used.

Part III: Bioschema optional

  • alternateName - An alias for the item.
  • conditionsOfAccess - Conditions that affect the availability of, or method(s) of access to, an item.
  • image - An image of the item.

Part IV: Codemeta fields

  • codeRepository
  • memoryRequirements
  • operatingSystem
  • processorRequirements
  • softwareHelp
  • storageRequirements
  • copyrightHolder
  • copyrightYear
  • embargoDate
  • issueTracker
  • referencePublication
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