Skip to content
GitLab
Projects
Groups
Snippets
Help
Loading...
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
vidjil
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
1,712
Issues
1,712
List
Boards
Labels
Service Desk
Milestones
Merge Requests
87
Merge Requests
87
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Operations
Operations
Incidents
Environments
Packages & Registries
Packages & Registries
Container Registry
Analytics
Analytics
CI / CD
Repository
Value Stream
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
vidjil
vidjil
Commits
7625d764
Commit
7625d764
authored
Oct 24, 2019
by
Mathieu Giraud
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
doc/vidjil-format.md: draft documentation on distributions
See
#4020
.
parent
e1b0ee25
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
39 additions
and
0 deletions
+39
-0
doc/vidjil-format.md
doc/vidjil-format.md
+39
-0
No files found.
doc/vidjil-format.md
View file @
7625d764
...
...
@@ -149,6 +149,7 @@ do a correct gathering.
}
```
## `.analysis` file
This file reflects the annotations a user could have done within the Vidjil web application or some other tool.
...
...
@@ -347,6 +348,44 @@ In the `.analysis` file, this section is intended to describe some specific clon
}
```
## `distributions`: providing statistics on full clonal populations
In some situations, one would like to represent whole distributions of clones
according to "axes" such as V/J distribution or length.
It is possible to specify in the
`.vidjil`
file such
`"distributions"`
without detailing the full list of clones, hence keeping a relatively small file
and enabling fast post-processing or visualizations.
In the example below, 5 clones (totaling 6 reads) have a length of 223.
Distributions can be on several axes, like both V/J (here seg3/seg5).
```
javascript
{
"
distributions
"
:
{
"
keys
"
:
[
"
clones
"
,
"
reads
"
],
"
repertoires
"
:
{
"
sample_42
"
:
[
{
"
axes
"
:
[
"
lenSeqAverage
"
],
"
values
"
:
{
"
223
"
:
[
5
,
6
],
"
232
"
:
[
1
,
7
],
"
260
"
:
[
5
,
20
]
}
},
{
"
axes
"
:
[
"
seg3
"
,
"
seg5
"
],
"
values
"
:
{
"
IGHJ3
"
:
{
"
IGHV4-39
"
:
[
5
,
20
]},
"
IGHJ4
"
:
{
"
IGHV3-23
"
:
[
1
,
7
],
"
IGHV3-64
"
:
[
1
,
1
]},
"
IGHJ6
"
:
{
"
IGHV1-24
"
:
[
2
,
3
],
"
IGHV1-8
"
:
[
2
,
2
]}
}
}]
}
}
}
}
```
## `germlines` list \[optional\]\[work in progress, to be documented\]
extend the
`germline.data`
default file with a custom germline
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment