Skip to content

Commit 037507c

Browse files
authored
docs(panel): sync parameter descriptions (#6)
* Update syncweaver ref to FigOutSync * Restore syncweaver source ref * chore(syncweaver): update MOSuite source to main _commit message is ai-generated_ * docs(panel): sync parameter descriptions _commit message is ai-generated_ * docs(changelog): add PR entry * test: add syncweaver lock coverage * test: remove syncweaver lock tests * Update CHANGELOG.md
1 parent 3210938 commit 037507c

3 files changed

Lines changed: 68 additions & 32 deletions

File tree

‎.codeocean/app-panel.json‎

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@
5454
"category": "FvI4Z2eb9sjL47Jt",
5555
"name": "Feature ID column name",
5656
"param_name": "feature_id_colname",
57-
"description": "Column name for feature IDs",
57+
"description": "The column from the counts data containing the Feature IDs, usually Gene or Protein ID. This is usually the first column of the input counts matrix. Only columns of text type from the input counts matrix are available to select for this parameter.",
5858
"type": "text",
5959
"value_type": "string"
6060
},
@@ -63,7 +63,7 @@
6363
"category": "EzTg1ivlFDHEy9PI",
6464
"name": "Significance column",
6565
"param_name": "significance_column",
66-
"description": "Column name for significance (e.g., pval or adjpval)",
66+
"description": "Column name for significance, such as pval or adjpval.",
6767
"type": "text",
6868
"value_type": "string",
6969
"default_value": "adjpval"
@@ -73,7 +73,7 @@
7373
"category": "EzTg1ivlFDHEy9PI",
7474
"name": "Significance cutoff",
7575
"param_name": "significance_cutoff",
76-
"description": "Features must be below this significance cutoff",
76+
"description": "Features are kept only if their significance_column value is less than this cutoff threshold.",
7777
"type": "text",
7878
"value_type": "string",
7979
"default_value": "0.05"
@@ -83,7 +83,7 @@
8383
"category": "EzTg1ivlFDHEy9PI",
8484
"name": "Change column",
8585
"param_name": "change_column",
86-
"description": "Column name for change (e.g., logFC)",
86+
"description": "Column name for change, such as logFC.",
8787
"type": "text",
8888
"value_type": "string",
8989
"default_value": "logFC"
@@ -93,7 +93,7 @@
9393
"category": "EzTg1ivlFDHEy9PI",
9494
"name": "Change cutoff",
9595
"param_name": "change_cutoff",
96-
"description": "Absolute change threshold",
96+
"description": "Features are kept only if the absolute value of their change_column value is greater than or equal to this cutoff threshold.",
9797
"type": "text",
9898
"value_type": "string",
9999
"default_value": "1"
@@ -103,7 +103,7 @@
103103
"category": "EzTg1ivlFDHEy9PI",
104104
"name": "Filtering mode",
105105
"param_name": "filtering_mode",
106-
"description": "Include features meeting criteria in any or all contrasts (any/all)",
106+
"description": "Accepted values are any or all, to include features that meet the criteria in any contrast or in all contrasts.",
107107
"type": "text",
108108
"value_type": "string",
109109
"default_value": "any"
@@ -113,7 +113,7 @@
113113
"category": "EzTg1ivlFDHEy9PI",
114114
"name": "Include estimates",
115115
"param_name": "include_estimates",
116-
"description": "Comma-separated list of estimates to include",
116+
"description": "Column names of estimates to include.",
117117
"type": "text",
118118
"value_type": "string",
119119
"default_value": "FC,logFC,tstat,pval,adjpval"
@@ -123,7 +123,7 @@
123123
"category": "EzTg1ivlFDHEy9PI",
124124
"name": "Round estimates",
125125
"param_name": "round_estimates",
126-
"description": "Whether to round estimates",
126+
"description": "Whether to round estimates.",
127127
"type": "list",
128128
"value_type": "string",
129129
"default_value": "TRUE",
@@ -137,7 +137,7 @@
137137
"category": "EzTg1ivlFDHEy9PI",
138138
"name": "Contrast filter",
139139
"param_name": "contrast_filter",
140-
"description": "Whether to keep, remove, or ignore contrast filtering",
140+
"description": "Whether to filter contrasts in or out of analysis. If keep, only the contrast names listed in contrasts are included. If remove, the contrast names listed by contrasts are removed. If none, all contrasts in the dataset are used.",
141141
"type": "text",
142142
"value_type": "string",
143143
"default_value": "none"
@@ -147,7 +147,7 @@
147147
"category": "EzTg1ivlFDHEy9PI",
148148
"name": "Contrasts",
149149
"param_name": "contrasts",
150-
"description": "Comma-separated list of contrasts to keep/remove",
150+
"description": "Contrast names to filter by contrast_filter. If contrast_filter is none, this parameter has no effect.",
151151
"type": "text",
152152
"value_type": "string"
153153
},
@@ -156,7 +156,7 @@
156156
"category": "EzTg1ivlFDHEy9PI",
157157
"name": "Groups",
158158
"param_name": "groups",
159-
"description": "Comma-separated list of groups to keep/remove",
159+
"description": "Group names to filter by groups_filter. If groups_filter is none, this parameter has no effect.",
160160
"type": "text",
161161
"value_type": "string"
162162
},
@@ -165,7 +165,7 @@
165165
"category": "EzTg1ivlFDHEy9PI",
166166
"name": "Groups filter",
167167
"param_name": "groups_filter",
168-
"description": "Whether to keep, remove, or ignore group filtering",
168+
"description": "Whether to filter groups in or out of analysis. If keep, only the group names listed in groups are included. If remove, the group names listed by groups are removed. If none, all groups in the dataset are used.",
169169
"type": "text",
170170
"value_type": "string",
171171
"default_value": "none"
@@ -175,7 +175,7 @@
175175
"category": "FvI4Z2eb9sjL47Jt",
176176
"name": "Rounding decimals for percent",
177177
"param_name": "rounding_decimal_for_percent_cells",
178-
"description": "Decimal places for percent labels",
178+
"description": "Decimal place to use when rounding Percent cells.",
179179
"type": "text",
180180
"value_type": "string",
181181
"default_value": "0"
@@ -185,7 +185,7 @@
185185
"category": "VisGeneral",
186186
"name": "Label font size",
187187
"param_name": "label_font_size",
188-
"description": "Font size for labels in plots",
188+
"description": "Font size for labels in the plot.",
189189
"type": "text",
190190
"value_type": "string",
191191
"default_value": "6"
@@ -195,7 +195,7 @@
195195
"category": "VisGeneral",
196196
"name": "Label distance",
197197
"param_name": "label_distance",
198-
"description": "Distance of labels from bars",
198+
"description": "Distance of labels from the bars.",
199199
"type": "text",
200200
"value_type": "string",
201201
"default_value": "1"
@@ -205,7 +205,7 @@
205205
"category": "VisBarChart",
206206
"name": "Y-axis expansion",
207207
"param_name": "y_axis_expansion",
208-
"description": "Expansion of the y-axis",
208+
"description": "Expansion of the y-axis.",
209209
"type": "text",
210210
"value_type": "string",
211211
"default_value": "0.08"
@@ -215,7 +215,7 @@
215215
"category": "VisGeneral",
216216
"name": "Fill colors",
217217
"param_name": "fill_colors",
218-
"description": "Comma-separated fill colors for bars",
218+
"description": "Fill colors for the bars.",
219219
"type": "text",
220220
"value_type": "string",
221221
"default_value": "steelblue1,whitesmoke"
@@ -225,7 +225,7 @@
225225
"category": "VisPieChart",
226226
"name": "Pie chart in 3D",
227227
"param_name": "pie_chart_in_3d",
228-
"description": "Whether to draw pie charts in 3D",
228+
"description": "Whether to draw pie charts in 3D.",
229229
"type": "list",
230230
"value_type": "string",
231231
"default_value": "TRUE",
@@ -239,7 +239,7 @@
239239
"category": "VisBarChart",
240240
"name": "Bar width",
241241
"param_name": "bar_width",
242-
"description": "Width of bars",
242+
"description": "Width of the bars.",
243243
"type": "text",
244244
"value_type": "string",
245245
"default_value": "0.4"
@@ -249,7 +249,7 @@
249249
"category": "VisBarChart",
250250
"name": "Draw bar border",
251251
"param_name": "draw_bar_border",
252-
"description": "Whether to draw borders around bars",
252+
"description": "Whether to draw borders around bars.",
253253
"type": "list",
254254
"value_type": "string",
255255
"default_value": "TRUE",
@@ -263,7 +263,7 @@
263263
"category": "VisGeneral",
264264
"name": "Plot type",
265265
"param_name": "plot_type",
266-
"description": "Plot type: bar or pie",
266+
"description": "Plot type, either bar or pie.",
267267
"type": "text",
268268
"value_type": "string",
269269
"default_value": "bar"
@@ -273,7 +273,7 @@
273273
"category": "VisGeneral",
274274
"name": "Plot titles fontsize",
275275
"param_name": "plot_titles_fontsize",
276-
"description": "Font size for plot titles",
276+
"description": "Font size for plot titles.",
277277
"type": "text",
278278
"value_type": "string",
279279
"default_value": "12"

‎CHANGELOG.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22

33
## Development version
44

5+
- Sync Code Ocean app panel parameter descriptions with MOSuite package documentation for MOSuite v0.4.1 (#6, @phoman14).
56
- Improved the Code Ocean parameter UI for the filter diff capsule (#2, @phoman14).
67
- Use MOSuite v0.3.2. (#3, @kelly-sovacool)
78

‎code/MOSuite/CITATION.cff‎

Lines changed: 45 additions & 10 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)