algorithm_store.json

{
  "name": "Descriptive Statistics",
  "code_url": "https://github.com/STRONGAYA/v6-descriptive-statistics",
  "documentation_url": "https://github.com/STRONGAYA/v6-descriptive-statistics/wiki",
  "vantage6_version": "4.7.0",
  "partitioning": "horizontal",
  "description": "",
  "image": "ghcr.io/strongaya/v6-descriptive-statistics:v1.0.0",
  "functions": [
    {
      "name": "central",
      "arguments": [
        {
          "name": "variables_to_describe",
          "description": "Dictionary of variables to describe. For categorical variables it should be structured as {variable_name: {datatype: categorical}}, and optionally as {variable: {datatype: categorical, inliers: (acceptable value 1, acceptable value 2, acceptable value 3, et cetera)}} when wanting to investigate outliers. For numerical variables it should be structured as {variable: {datatype: numerical, inliers: (minimum range, maximum range)}} ",
          "type": "json"
        },
        {
          "name": "variables_to_stratify",
          "description": "To be implemented",
          "type": "json"
        },
        {
          "name": "organization_ids",
          "description": "List of organisation IDs to include. Defaults to None",
          "type": "organization_list"
        }
      ],
      "type": "central",
      "databases": [],
      "description": "Vantage6 algorithm that retrieves descriptive statistics",
      "ui_visualizations": [
        {
          "name": "Categorical descriptives",
          "type": "table",
          "schema": {
            "location": [
              "categorical_descriptives"
            ],
            "columns": []
          },
          "description": "A table providing the aggregate descriptive statistics for categorical data."
        },
        {
          "name": "Numerical descriptives",
          "type": "table",
          "schema": {
            "location": [
              "numerical_descriptives"
            ],
            "columns": []
          },
          "description": "A table providing the aggregate descriptive statistics for numerical data."
        }
      ]
    },
    {
      "name": "partial",
      "arguments": [
        {
          "name": "variables_to_describe",
          "description": "Dictionary of variables to describe. For numerical variables it should be structured as {variable_name: {datatype: numerical/categorical}}, and optionally as {variable: {datatype: numerical, inliers: (minimum range, maximum range)}} when wanting to investigate outliers. For categorical variables it should be structured as {variable: {datatype: categorical, inliers: (acceptable value 1, acceptable value 2, acceptable value 3, et cetera)}} ",
          "type": "json"
        },
        {
          "name": "variables_to_stratify",
          "description": "To be implemented",
          "type": "json"
        }
      ],
      "type": "federated",
      "databases": [
        {
          "name": "Database 1",
          "description": ""
        }
      ],
      "description": "Partial algorithm that retrieves descriptive statistics",
      "ui_visualizations": []
    }
  ]
}