v6-crosstab/algorithm_store.json at main · STRONGAYA/v6-crosstab · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
{
  "name": "Contingency table",
  "image": "ghcr.io/vantage6/algorithm/crosstab",
  "vantage6_version": "5.0.0",
  "code_url": "https://github.com/vantage6/v6-crosstab-py.git",
  "documentation_url": "https://algorithms.vantage6.ai/en/latest/v6-crosstab-py/docs/index.html",
  "partitioning": "horizontal",
  "description": "Compute a contingency table of two or more variables. Optionally compute a chi2 statistic.",
  "functions": [
    {
      "name": "central_crosstab",
      "display_name": "Crosstab",
      "standalone": true,
      "description": "Create a contingency table showing the relationship between two or more variables",
      "step_type": "central_compute",
      "ui_visualizations": [
        {
          "name": "Contingency table",
          "schema": {
            "location": ["contingency_table"],
            "columns": []
          },
          "description": "Contingency table that shows the relations between the requested variables for all nodes combined.",
          "type": "table"
        },
        {
          "name": "Chi-squared test",
          "schema": {
            "location": ["chi2"],
            "columns": []
          },
          "description": "Results of the chi-squared test for the contingency table.",
          "type": "table"
        }
      ],
      "arguments": [
        {
          "name": "results_col",
          "display_name": "Results column",
          "description": "Column to count. Will be used as the columns in the contingency table",
          "type": "column",
          "has_default_value": false,
          "is_frontend_only": false
        },
        {
          "name": "group_cols",
          "display_name": "Group columns",
          "description": "One or more columns to group by. Will be used as the rows in the contingency table",
          "type": "column_list",
          "has_default_value": false,
          "is_frontend_only": false
        },
        {
          "name": "organizations_to_include",
          "display_name": "Organizations to include",
          "description": "Organizations to be included in the analysis",
          "type": "organization_list",
          "has_default_value": true,
          "is_frontend_only": false,
          "default_value": null
        },
        {
          "name": "include_chi2",
          "display_name": "Include chi-squared test",
          "description": "Whether to include the results of a chi-squared statistic test in the results or not. By default, it is included.",
          "type": "boolean",
          "has_default_value": true,
          "is_frontend_only": false,
          "default_value": true
        },
        {
          "name": "include_totals",
          "display_name": "Include totals",
          "description": "Whether to include the sums of the rows and columns or not. By default, they are included.",
          "type": "boolean",
          "has_default_value": true,
          "is_frontend_only": false,
          "default_value": true
        }
      ],
      "databases": [
        {
          "name": "Database",
          "description": "Database to use for the contingency table"
        }
      ]
    },
    {
      "name": "partial_crosstab",
      "display_name": "Crosstab per data station",
      "standalone": true,
      "description": "Compute a contingency table for one data station. The shared result includes ranges where values are below a privacy threshold.",
      "step_type": "federated_compute",
      "ui_visualizations": [
        {
          "name": "Contingency table",
          "schema": {
            "location": [],
            "columns": []
          },
          "description": "Partial contingency table that shows the contingency table shared by this node.",
          "type": "table"
        }
      ],
      "arguments": [
        {
          "name": "results_col",
          "display_name": "Results column",
          "description": "Column to count. Will be used as the columns in the contingency table",
          "type": "column",
          "has_default_value": false,
          "is_frontend_only": false
        },
        {
          "name": "group_cols",
          "display_name": "Group columns",
          "description": "One or more columns to group by. Will be used as the rows in the contingency table",
          "type": "column_list",
          "has_default_value": false,
          "is_frontend_only": false
        }
      ],
      "databases": [
        {
          "name": "Database",
          "description": "Database to use for the contingency table"
        }
      ]
    }
  ]
}