Commit 436dc361 authored by Mathieu Giraud's avatar Mathieu Giraud

doc/dev.org, doc/user.org: client API

parent 385a6c8a
......@@ -67,9 +67,9 @@ This will unlock the =patients= menu and allow your local browser
to access the public server at http://app.vidjil.org/.
** 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,19 @@ 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 loads data from a server (see below, requires logging), as in http://app.vidjil.org/?set=3241&config=39
- "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 XXXXX
- "plot=x,y,m". plot (x axis, y ayis) axis names are found in js/axes.js. mode is optional, can be ....
- "clone=xx,xx,xx" selected clone ids
We intend to encode more parameters in the URL.
** Architecture
......@@ -179,14 +192,6 @@ The first three solutions need some further elements from the full =index.html=.
=stop=. Some of them can be explicitly not displayed by filling the
=exclude_seg_info= array in =getHtmlInfo=.
****url
the system of API/url allow to pass some parameter through the url. the view Url.js get some parameter and add them to the url
the parameters are :
-scatterplot settings eg: axis label
-sampleset id
- selected clone id
- config id
* Server
** Notifications
......
......@@ -184,15 +184,16 @@ edited ('e') or deleted ('X').
They are just different ways to group samples.
Sets can for example gather a set of samples of a same experiment.
Runs can be used to gather samples that have been sequenced in the same run.
****url
the system of API/url allow to pass some parameter through the url.
the parameters are :
- scatterplot settings eg: axis label
- sampleset id
- selected clone id
- config id
- data to be loaded
this system allow to work more efficiently with other user as you can give them your working url .
** Permanent address (URLs) to a set of samples
Adresses such http://app.vidjil.org/?set=3241&config=39 directly target a set of samples (here the public dataset L3), possibly with your saved analyzed.
Moreover, the adress also encode other parameters, such in http://app.vidjil.org/?set=3241&config=39&plot=v,size,bar&clone=11,31 (selected axes and selected clones).
To discuss on some results or to raise any issue, you can share such adresses with other users (with whom you share access grants, see below),
to your local IT staff or to the Vidjil team .
......
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