Skip to content

Commit 2c9a2a9

Browse files
docs(panel): sync parameter descriptions (#8)
* 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 --------- Co-authored-by: Kelly Sovacool <kelly.sovacool@nih.gov>
1 parent ed4b326 commit 2c9a2a9

2 files changed

Lines changed: 16 additions & 15 deletions

File tree

‎.codeocean/app-panel.json‎

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@
4242
"category": "gn9FXwemlVazWQIo",
4343
"name": "Clean up column names",
4444
"param_name": "cleanup_column_names",
45-
"description": "Automatically alter invalid column names by adding X prefix to names starting with numerals and replacing special characters (-,:. ) with underscores",
45+
"description": "Invalid raw counts column names can cause errors in downstream analysis. If TRUE, invalid column names are automatically altered by adding X to names that begin with a numeral and replacing special characters (-,:. ) with underscores. Invalid sample names and changes made will be reported.",
4646
"type": "list",
4747
"value_type": "string",
4848
"default_value": "TRUE",
@@ -56,7 +56,7 @@
5656
"category": "gn9FXwemlVazWQIo",
5757
"name": "Split gene names",
5858
"param_name": "split_gene_name",
59-
"description": "Split the gene name column by special characters: ,|_-:",
59+
"description": "If TRUE, split the gene name column by any of these special characters: ,|_-:",
6060
"type": "list",
6161
"value_type": "string",
6262
"default_value": "TRUE",
@@ -70,7 +70,7 @@
7070
"category": "gn9FXwemlVazWQIo",
7171
"name": "Aggregate duplicate gene names",
7272
"param_name": "aggregate_rows_with_duplicate_gene_names",
73-
"description": "Sum counts across duplicate Feature ID rows into a single row within each sample",
73+
"description": "If a Feature ID is duplicated on multiple rows of the raw counts, the log will report these Feature IDs. When TRUE, counts for duplicate Feature IDs are aggregated into a single row by summing counts across duplicate rows within each sample. Additional identifier columns, if present, are preserved and multiple matching identifiers appear as comma-separated values.",
7474
"help_text": "When TRUE, additional identifier columns (e.g. Ensembl IDs) are preserved and multiple matching identifiers appear as comma-separated values.",
7575
"type": "list",
7676
"value_type": "string",
@@ -85,8 +85,8 @@
8585
"category": "gn9FXwemlVazWQIo",
8686
"name": "Column for collapsing duplicates",
8787
"param_name": "gene_name_column_to_use_for_collapsing_duplicates",
88-
"description": "Column with Feature IDs to use as grouping elements to collapse the counts matrix",
89-
"help_text": "Leave blank to use the Feature ID column by default. If the Feature ID column can be split, the non-Ensembl ID name will be used. If no Ensembl IDs are detected, split IDs will be named Feature_id_1 and Feature_id_2.",
88+
"description": "Select the column with Feature IDs to use as grouping elements to collapse the counts matrix. The log output lists columns available to identify duplicate row IDs for aggregation.",
89+
"help_text": "Leaving this empty uses the Feature ID column. If the Feature ID column can be split, the non-Ensembl ID name will be used. If no Ensembl IDs are detected, split IDs will be named Feature_id_1 and Feature_id_2.",
9090
"type": "text",
9191
"value_type": "string"
9292
},
@@ -95,8 +95,8 @@
9595
"category": "Visualization",
9696
"name": "Group column name",
9797
"param_name": "group_colname",
98-
"description": "Column from sample metadata used to color the read-depth plot",
99-
"help_text": "Leave blank to use one color for all samples.",
98+
"description": "Sample metadata column used to color the read-depth plot.",
99+
"help_text": "Leaving this empty uses one color for all samples.",
100100
"type": "text",
101101
"value_type": "string",
102102
"default_value": "Group"
@@ -106,8 +106,8 @@
106106
"category": "Visualization",
107107
"name": "Colors for read-depth plot",
108108
"param_name": "colors_for_plots",
109-
"description": "Comma-separated list of colors for read-depth groups",
110-
"help_text": "Use color names or hex codes. Leave blank to use defaults.",
109+
"description": "Optional colors used when group_colname is supplied. Named vectors are matched to group values; unnamed vectors follow group order and are extended with MOSuite colors when too few colors are supplied.",
110+
"help_text": "Use color names or hex codes. Leaving this empty uses stored MOSuite colors.",
111111
"type": "text",
112112
"value_type": "string",
113113
"default_value": "#5954d6,#e1562c,#b80058,#00c6f8,#d163e6,#00a76c,#ff9287,#008cf9,#006e00,#796880,#FFA500,#878500"
@@ -117,7 +117,7 @@
117117
"category": "XqgPq28Eo5VCFSZu",
118118
"name": "count type",
119119
"param_name": "count_type",
120-
"description": "which counts to clean. Must be a count type in names(moo@counts)",
120+
"description": "The type of counts to use. Must be a name in the counts slot, moo@counts.",
121121
"type": "text",
122122
"value_type": "string",
123123
"default_value": "raw"
@@ -127,8 +127,8 @@
127127
"category": "XqgPq28Eo5VCFSZu",
128128
"name": "Sample ID Column Name",
129129
"param_name": "sample_id_colname",
130-
"description": "Column name in the sample metadata containing sample IDs",
131-
"help_text": "Leave blank to use the first column in the sample metadata by default",
130+
"description": "The column from the sample metadata containing the sample names. The names in this column must exactly match the names used as sample column names in the input counts matrix.",
131+
"help_text": "Leaving this empty uses the first column in the sample metadata.",
132132
"type": "text",
133133
"value_type": "string"
134134
},
@@ -137,8 +137,8 @@
137137
"category": "XqgPq28Eo5VCFSZu",
138138
"name": "Feature ID column name",
139139
"param_name": "feature_id_colname",
140-
"description": "Column name in the counts matrix containing feature IDs",
141-
"help_text": "Leave blank to use the first column by default",
140+
"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.",
141+
"help_text": "Leaving this empty uses the first column in the counts matrix.",
142142
"type": "text",
143143
"value_type": "string"
144144
},
@@ -147,7 +147,7 @@
147147
"category": "XqgPq28Eo5VCFSZu",
148148
"name": "Samples to rename",
149149
"param_name": "samples_to_rename",
150-
"description": "Sample names to rename (advanced)",
150+
"description": "Use this parameter to rename samples manually. Provide mappings in the format old_name: new_name; add each additional sample renaming as another item or comma-separated mapping.",
151151
"type": "text",
152152
"value_type": "string"
153153
}

‎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 (#8, @phoman14).
56
- Fixed the Code Ocean panel so parameters are passed to `main.R` by name instead of as positional values (#2, @phoman14).
67
- Improved the Code Ocean parameter UI for the clean capsule (#2, @phoman14).
78
- Added read-depth plot group color controls to the Visualization panel (#2, @phoman14).

0 commit comments

Comments
 (0)