Skip to content

Commit f5139bf

Browse files
Update callbarcodes.py docs (#240)
* Update callbarcodes.py Updated documentation with more details on channel naming and outputs. * delete duplicated text --------- Co-authored-by: Erin Weisbart <54687786+ErinWeisbart@users.noreply.github.com>
1 parent b928c0b commit f5139bf

1 file changed

Lines changed: 16 additions & 12 deletions

File tree

active_plugins/callbarcodes.py

Lines changed: 16 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -48,21 +48,25 @@
4848
One column contains the corresponding gene/transcript names.
4949
All other columns in the .csv will be ignored.
5050
51-
Before running this module in your pipeline, you need to identify the objects in which you will be calling your barcodes and you will need to have measured the intensities of each object in four channels corresponding to nucleotides A,C,T, and G.
51+
Before running this module in your pipeline, you need to identify the objects in which you will be calling your barcodes and you will need to have measured the intensities of each object in four channels corresponding to nucleotides A,C,T, and G.
52+
53+
Your images for each nucleotide channel per cycle must be named in a particular way for this module to work as intended. For example, 'Cycle01_A_BackSub' is a valid name. Begin with 'Cycle' then the cycle number '01, 02...', then the nucleotide and any other information can follow.
54+
5255
If the background intensities of your four channels are not very well matched, you might want to run the **CompensateColors** module before measuring the object intensities.
5356
5457
What do I get as output?
5558
^^^^^^^^^^^^^^^^^^^^^^^^
56-
To be added
59+
Image- and object-level measurements about barcode calling and score. Optionally, images of objects color-coded by barcode call or matching score.
5760
5861
Measurements made by this module
5962
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
6063
Within the InputObject.csv, this module outputs the following measurements:
61-
- BarcodeCalled is the n-cycle string of the barcode sequence that was read by the module
62-
- MatchedTo_Barcode is the known barcode that the module best matched to the called barcode
63-
- MatchedTo_ID is an ID number assigned to each known barcode
64-
- MatchedTo_GeneCode is the known gene/transcript name that corresponds to the known barcode
65-
- MatchedTo_Score is the quality of the called barcode to known barcode match, reported as (matching nucleotides)/(total nucleotides) where 1 is a perfect match
64+
65+
- **BarcodeCalled** is the n-cycle string of the barcode sequence that was read by the module
66+
- **MatchedTo_Barcode** is the known barcode that the module best matched to the called barcode
67+
- **MatchedTo_ID** is an ID number assigned to each known barcode
68+
- **MatchedTo_GeneCode** is the known gene/transcript name that corresponds to the known barcode
69+
- **MatchedTo_Score** is the quality of the called barcode to known barcode match, reported as (matching nucleotides)/(total nucleotides) where 1 is a perfect match
6670
6771
Note that CellProfiler cannot create a per-parent mean measurement of a string.
6872
@@ -137,22 +141,22 @@ def set_directory_fn(path):
137141
self.input_object_name.get_value,
138142
"AreaShape_Area",
139143
doc="""\
140-
This measurement should be """,
144+
This measurement should be an intensity measure that is measured for every cycle and is of a category that distinguishes different nucleotides. If named correctly (see main module input help), this module will gather the appropriate measurement for all nucleotides. For example, choosing the maximum intensity in the channel for nucleotide A will also use max intensity for C, T, G.""",
141145
)
142146

143147
self.metadata_field_barcode = cellprofiler_core.setting.choice.Choice(
144-
"Select the column of barcodes to match against",
148+
"Select the column containing barcodes to match against",
145149
["No CSV file"],
146150
choices_fn=self.get_choices,
147-
doc="""\Select the column of barcodes to match against.
151+
doc="""\Select the column containing barcodes to match against.
148152
""",
149153
)
150154

151155
self.metadata_field_tag = cellprofiler_core.setting.choice.Choice(
152-
"Select the column with gene/transcript barcode names",
156+
"Select the column containing gene/transcript barcode names",
153157
["No CSV file"],
154158
choices_fn=self.get_choices,
155-
doc="""\Select the column with gene/transcript barcode names.
159+
doc="""\Select the column containing gene/transcript barcode names.
156160
""",
157161
)
158162

0 commit comments

Comments
 (0)