Assays
Generate snail assays.
Assay
Bases: BaseModel
A single assay.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
ident
|
str
|
unique identifier |
required |
specimen
|
str
|
which specimen |
required |
person
|
str
|
who did the assay |
required |
machine
|
str
|
machine ID |
required |
performed
|
date
|
date assay was performed |
required |
readings
|
Grid[float]
|
assay readings |
required |
treatments
|
Grid[str]
|
samples or controls |
required |
Source code in src/snailz/assays.py
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 |
|
as_chunk()
Generate chunk for inclusion in overall assay CSV.
Returns:
Type | Description |
---|---|
list[list[str]]
|
Rows of data. |
Source code in src/snailz/assays.py
38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 |
|
to_csv(kind)
Return a CSV string representation of the assay data.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
kind
|
str
|
Either "readings" or "treatments" |
required |
Returns:
Type | Description |
---|---|
str
|
A CSV-formatted string with the assay data. |
Raises:
Type | Description |
---|---|
ValueError
|
If 'kind' is not "readings" or "treatments" |
Source code in src/snailz/assays.py
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 |
|
AllAssays
Bases: BaseModel
All generated assays.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
items
|
list[Assay]
|
actual assays |
required |
Source code in src/snailz/assays.py
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 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 |
|
max_reading()
Find maximum assay reading value.
Returns:
Type | Description |
---|---|
float
|
Largest reading value across all assays. |
Source code in src/snailz/assays.py
110 111 112 113 114 115 116 117 118 119 |
|
to_csv(summary=True)
Return a CSV string representation of the assay summary data.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
summary
|
bool
|
produce summary (default) or include all results |
True
|
Returns:
Type | Description |
---|---|
str
|
A CSV-formatted string containing assay data |
Source code in src/snailz/assays.py
122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 |
|
generate(params, persons, machines, specimens)
staticmethod
Generate an assay for each specimen.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
params
|
AssayParams
|
assay generation parameters |
required |
persons
|
AllPersons
|
all staff members |
required |
machines
|
AllMachines
|
all laboratory equipment |
required |
specimens
|
AllSpecimens
|
specimens to generate assays for |
required |
Returns:
Type | Description |
---|---|
AllAssays
|
Assay list object |
Source code in src/snailz/assays.py
153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 |
|
_make_readings(params, specimen, performed, machine, treatments)
Make a single assay.
Source code in src/snailz/assays.py
199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 |
|
_make_treatments(params)
Generate random treatments.
Source code in src/snailz/assays.py
217 218 219 220 221 222 223 224 225 226 227 228 |
|