Improvement of description on "potentialAction (object of a ControlAction)" in tools specification

profgiuseppe commented 6 years ago

There are two possible improvements for this property:

the schema.org refers to "see potentialAction above... which has type of Action", however there is no potentialAction above in Bioschemas specifications, neither the type is Action
there are two properties with the same name, labelled as input and output This may be confusing for the users, while it could be made clear that it is a single ControlAction object, containing two properties: object (for input) and result (for output). Please see this example for a possible usage

stain commented 3 years ago

we did consider potentialAction for workflows in earlier RO-Crate:

       {
            "@id": "workflow/retropath.knime",  
            "@type": "SoftwareSourceCode",
            "additionalType": {"@id": "Workflow"},
            "name": "RetroPath Knime workflow",
            "description": "KNIME implementation of RetroPath2.0 workflow",
            "author": {"@id": "#thomas"},
            "programmingLanguage": {"@id": "#knime"},
            "license": "https://spdx.org/licenses/BSD-2-Clause.html",
            "potentialAction": {
                "@type": "ActivateAction",
                "instrument": {"@id": "#knime"}
            }
        }

       {
            "@id": "#knime",
            "@type": [
                "ComputerLanguage",
                "SoftwareApplication"
            ],
            "name": "KNIME Analytics Platform",
            "alternateName": "KNIME",
            "url": {"@id": "https://www.knime.com/knime-software/knime-analytics-platform"},
            "version": "3.6"
        }

In here you can consider the workflow script as a becoming the object of a new https://schema.org/Action using the workflow engine as instrument

albangaignard commented 3 years ago

Not considered as suitable for now. It would need more use cases do be provided.

BioSchemas / specifications

Improvement of description on "potentialAction (object of a ControlAction)" in tools specification #126