Commit ac33134e authored by flothoni's avatar flothoni

doc; improve description of clones type

Link to #4020
parent 40ebbc7d
Pipeline #106220 passed with stage
in 8 seconds
......@@ -72,14 +72,24 @@ as well with the locus selection.
- Other objects: `Report`, `Shortcut`
Extends functionalities but requires elements from the full `index.html`.
### Clone types
By default, 3 types of clone is created: constant, distribution and other.
* `Constant` clone: correspond to real clone describe into the vidjil file, individually. They are limited to the top clones of a sample (100x by sample).
* `Other`, or smaller clones: corresponding to the sum of each clones of a given locus, with size dynamically computed to take into account the current filter and viewable constant clones.
* `Distributions` clones: correspond to the values given into the distributions data of the vidjil file. They are generated by a function of the model (`loadAllDistribClones`) that automatically agregate data of distributions for each samples. It agregate information on each clones that cannon't be view or show in the interface. It is particularry usefull to simmulate a genescan view in the interface for example.
### Clone attributes
Clone use [boolean mask](https://en.wikipedia.org/wiki/Mask_(computing)) in order to specify attributes.
These attributes allow specific behavior inside the client.
C_SIZE_CONSTANT
C_SIZE_DISTRIB
C_SIZE_OTHER
Each clone has one (and only one) of these attributes.
Each clone has one (and only one) attributes linked to his type/size.
Either its raw size is constant (`_CONSTANT`), either it is computed from other clones (`_DISTRIB`, `_OTHER`).
Note that, that in each case, the displayed size can be different from the raw size
due to normalizations.
......@@ -103,26 +113,19 @@ Each clone that has values on the current axes will be displayed in the 'scatter
Each clone that has a sequence will be displayed in the bottom 'segmenter' panel.
### Clone creation
### Clone creation
Clone use [boolean mask](https://en.wikipedia.org/wiki/Mask_(computing)) in order to specify attributes.
By default, 3 types of clone is created: constant, distribution and other.
Here are the command and attributes of each common type:
Here are commands and set of attributes for each common type:
Constant clone correspond to real clone describe into the vidjil file, individually. They are limited to the top clones of a sample.
```javascript
// Constant
new Clone(data, model, index, C_SIZE_CONSTANT | C_CLUSTERIZABLE | C_INTERACTABLE | C_IN_SCATTERPLOT);
```
Other, or smaller clones, corresponding to the sum of each clones of a given locus, with size dynamicly computed to take into account the current filter and viewable constant clones.
```javascript
new Clone(other, self, index, C_SIZE_OTHER);
```
Distributions clones corresponding to the values given into the distributions data of the vidjil file. They are generated by a function of the model (`loadAllDistribClones`) that automatically agregate data of distributions for each samples. They agregate information on each clones that cannon't be view or show in the interface. They are particularry usefull to simmulate a genescan view in the interface for example.
```javascript
// Other
new Clone(data, model, index, C_SIZE_OTHER);
// Distributions
new Clone(data, model, index, C_SIZE_DISTRIB | C_INTERACTABLE | C_IN_SCATTERPLOT );
```
The data contain the set of values specify for a clone (locus, segments, number of reads, ...).
## Integrating the client
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment