Protocol Output

The protocol_output attribute is an object that will inform the client how to display information to the user after executing the protocol.

dynamic_description

usage: optional - datatype: string

The dynamic_description attribute is used to give an overview of what the protocol is analyzing. The dynamic_description can include references for the arguments in the protocol. The references will be replaced by the variables, collections, or values selected for the argument.

"dynamic_description": "Give an overview of the analysis with ARGUMENT_VALUE(argument_name)[ prefix text :: suffix text ]." 

export

usage: required - datatype: array

export is an array which contains method-specific strings for the rendering of stock visualizations. The standard export for a tag-comparison method would include tag-tag and numeric-tag, while a numeric-comparison method would include numeric-tag and numeric-numeric.

"export": [
  "tag-tag",
  "numeric-tag",
  "numeric-numeric"
]

visualization

usage: required - datatype: array

The visualization attribute contains objects to customize the rendering of protocol results. The visualization attribute can include references for the arguments in the protocol or to display entity count placeholders. The references will be replaced by the variables, collections, or values as selected for the argument. There are also a number of descriptor types and options to adjust decimal places or graphic coloring. See the Protocol Visualization Reference for more details.

"visualization": [
  {
    "visualization_type": "numeric-tag",
    "descriptors": [
      {"focus-mean": "Average value of 'COLLECTION_PLACEHOLDER: VARIABLE_PLACEHOLDER' for cases in the focus  cohort ARGUMENT_VALUE(argument_name) (FOCUS_COUNT_PLACEHOLDER entities)"},
      {"background-mean": "Average value of 'COLLECTION_PLACEHOLDER: VARIABLE_PLACEHOLDER' for all cases (BACKGROUND_COUNT_PLACEHOLDER entities)"}
    ],
    "digits": 2
  }
]