Commit 7f05f76e authored by Mathieu Giraud's avatar Mathieu Giraud

Merge branch 'doc/update_tutorial' into dev

parents 627169a0 3136741b
Pipeline #10947 passed with stages
in 14 seconds
......@@ -67,9 +67,9 @@ This will unlock the =patients= menu and allow your local browser
to access the public server at
** Browser API
** Client API and permanent URLs
The browser can be opened on a data file specified from a =data= attribute,
The client can be opened on a data file specified from a =data= attribute,
and optionally on an analysis file specified from a =analysis= attribute,
as in the following URLs on our test server:
......@@ -81,6 +81,21 @@ Both GET and POST requests are accepted.
Note that the =browser/index.html= file and the =.vidjil/.analysis= files should be hosted on the same server.
Otherwise, the server hosting the =.vidjil/.analysis= files must accept cross-domain queries.
The client can also load data from a server (see below, requires logging), as in
| =set=xx= | sample set id |
| =config=xx= | config id |
Older formats (patients, run...) are also supported for compatibility but deprecated.
Moreover, the state of the client can be encoded in the URL, as in,size,bar&clone=11,31
| =plot=x,y,m= | plot (x axis, y axis) |
| =clone=xx,xx,xx= | selected clone ids |
For =plot= the axis names are found in =browser/js/axes.js=. =m= is optional, and defines the type of plot (either =grid= or =bar=).
We intend to encode more parameters in the URL.
** Architecture
......@@ -7,7 +7,7 @@
\usepackage[margin=3.2cm, top=1.5cm, bottom=2cm,left=1.5cm,a4paper]{geometry}
\usepackage[margin=3.2cm, top=2cm, bottom=2cm,left=2cm,a4paper]{geometry}
This diff is collapsed.
This diff is collapsed.
......@@ -187,6 +187,16 @@ Runs can be used to gather samples that have been sequenced in the same run.
** Permanent address (URLs) to a set of samples
Addresses such as directly target a set of samples (here the public dataset L3), possibly with your saved analysis.
Moreover, the address also encodes other parameters, for instance,size,bar&clone=11,31 (selected axes and selected clones).
To discuss on some results or to raise any issue, you can share such addresses with other users (with whom you share access grants, see below),
to your local IT staff or to the Vidjil team.
** Samples and pre-processes
Clicking on a patient, a run or a set give acccess to the "samples" page. Each sample is
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