|
42 | 42 | "category": "gn9FXwemlVazWQIo", |
43 | 43 | "name": "Clean up column names", |
44 | 44 | "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.", |
46 | 46 | "type": "list", |
47 | 47 | "value_type": "string", |
48 | 48 | "default_value": "TRUE", |
|
56 | 56 | "category": "gn9FXwemlVazWQIo", |
57 | 57 | "name": "Split gene names", |
58 | 58 | "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: ,|_-:", |
60 | 60 | "type": "list", |
61 | 61 | "value_type": "string", |
62 | 62 | "default_value": "TRUE", |
|
70 | 70 | "category": "gn9FXwemlVazWQIo", |
71 | 71 | "name": "Aggregate duplicate gene names", |
72 | 72 | "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.", |
74 | 74 | "help_text": "When TRUE, additional identifier columns (e.g. Ensembl IDs) are preserved and multiple matching identifiers appear as comma-separated values.", |
75 | 75 | "type": "list", |
76 | 76 | "value_type": "string", |
|
85 | 85 | "category": "gn9FXwemlVazWQIo", |
86 | 86 | "name": "Column for collapsing duplicates", |
87 | 87 | "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.", |
90 | 90 | "type": "text", |
91 | 91 | "value_type": "string" |
92 | 92 | }, |
|
95 | 95 | "category": "Visualization", |
96 | 96 | "name": "Group column name", |
97 | 97 | "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.", |
100 | 100 | "type": "text", |
101 | 101 | "value_type": "string", |
102 | 102 | "default_value": "Group" |
|
106 | 106 | "category": "Visualization", |
107 | 107 | "name": "Colors for read-depth plot", |
108 | 108 | "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.", |
111 | 111 | "type": "text", |
112 | 112 | "value_type": "string", |
113 | 113 | "default_value": "#5954d6,#e1562c,#b80058,#00c6f8,#d163e6,#00a76c,#ff9287,#008cf9,#006e00,#796880,#FFA500,#878500" |
|
117 | 117 | "category": "XqgPq28Eo5VCFSZu", |
118 | 118 | "name": "count type", |
119 | 119 | "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.", |
121 | 121 | "type": "text", |
122 | 122 | "value_type": "string", |
123 | 123 | "default_value": "raw" |
|
127 | 127 | "category": "XqgPq28Eo5VCFSZu", |
128 | 128 | "name": "Sample ID Column Name", |
129 | 129 | "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.", |
132 | 132 | "type": "text", |
133 | 133 | "value_type": "string" |
134 | 134 | }, |
|
137 | 137 | "category": "XqgPq28Eo5VCFSZu", |
138 | 138 | "name": "Feature ID column name", |
139 | 139 | "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.", |
142 | 142 | "type": "text", |
143 | 143 | "value_type": "string" |
144 | 144 | }, |
|
147 | 147 | "category": "XqgPq28Eo5VCFSZu", |
148 | 148 | "name": "Samples to rename", |
149 | 149 | "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.", |
151 | 151 | "type": "text", |
152 | 152 | "value_type": "string" |
153 | 153 | } |
|
0 commit comments