navan
/
classyfire_api
mirror of https://bitbucket.org/wishartlab/classyfire_api
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

updated documentation

This commit is contained in:
djoumbou 2016-03-09 19:55:54 -07:00
parent 0fa92f1800
commit 767a49fc07
9 changed files with 26 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@ -57,6 +57,7 @@
> > > >
> > >The sequence's fingerprint is "8bf70c23ac100cd2c3955081d8613325", > > >The sequence's fingerprint is "8bf70c23ac100cd2c3955081d8613325",
> > > > The fingerprint is generate by Digest::MD5 from the peptide sequence "APDVQDCPECTLQENPFFSQPGAPILQCMGCCFSRAYPTPLRSKKTMLVQKNVTSESTCCVAKSYNRVTVMGGFKVENHTACHCSTCYYHKS" > > > > The fingerprint is generate by Digest::MD5 from the peptide sequence "APDVQDCPECTLQENPFFSQPGAPILQCMGCCFSRAYPTPLRSKKTMLVQKNVTSESTCCVAKSYNRVTVMGGFKVENHTACHCSTCYYHKS"
> > >
> > >The output format is "json" (JSON). > > >The output format is "json" (JSON).
@ -66,6 +67,7 @@
> > >The query label is an identifier > > >The query label is an identifier
> > > > > >
> > >The query input contains the compound's identifier (optional) and its structural representation, separated by a tab. The chemical structure is represented either in the [Daylight SMILES](http://www.daylight.com/dayhtml/doc/theory/theory.smiles.html) format, the [InChI](http://www.iupac.org/home/publications/e-resources/inchi.html) format. Moreover, the compound can be represented with its [IUPAC name](http://www.chem.qmul.ac.uk/iupac/). > > >The query input contains the compound's identifier (optional) and its structural representation, separated by a tab. The chemical structure is represented either in the [Daylight SMILES](http://www.daylight.com/dayhtml/doc/theory/theory.smiles.html) format, the [InChI](http://www.iupac.org/home/publications/e-resources/inchi.html) format. Moreover, the compound can be represented with its [IUPAC name](http://www.chem.qmul.ac.uk/iupac/).
> > >The input can also be of type [FASTA](https://en.wikipedia.org/wiki/FASTA_format), which contains peptide or nucleotide sequences.
> > > >
> >###POST### > >###POST###
> >A query can be submitted using the POST method as demonstrated in the following example. > >A query can be submitted using the POST method as demonstrated in the following example.

2
doc/ClassyFireAPI.html
View File

@ -2066,7 +2066,7 @@ text. is fragmented into n part of #slice_length entries each).</p>
</div> </div>
<div id="footer"> <div id="footer">
Generated on Wed Mar 9 19:48:06 2016 by Generated on Wed Mar 9 19:55:20 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.3.0). 0.8.7.6 (ruby-2.3.0).
</div> </div>

2
doc/EntityResource.html
View File

@ -114,7 +114,7 @@
</div> </div>
<div id="footer"> <div id="footer">
Generated on Wed Mar 9 19:48:06 2016 by Generated on Wed Mar 9 19:55:20 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.3.0). 0.8.7.6 (ruby-2.3.0).
</div> </div>

2
doc/QueryResource.html
View File

@ -183,7 +183,7 @@
</div> </div>
<div id="footer"> <div id="footer">
Generated on Wed Mar 9 19:48:06 2016 by Generated on Wed Mar 9 19:55:20 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.3.0). 0.8.7.6 (ruby-2.3.0).
</div> </div>

2
doc/SequenceResource.html
View File

@ -114,7 +114,7 @@
</div> </div>
<div id="footer"> <div id="footer">
Generated on Wed Mar 9 19:48:06 2016 by Generated on Wed Mar 9 19:55:20 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.3.0). 0.8.7.6 (ruby-2.3.0).
</div> </div>

2
doc/_index.html
View File

@ -140,7 +140,7 @@
</div> </div>
<div id="footer"> <div id="footer">
Generated on Wed Mar 9 19:48:06 2016 by Generated on Wed Mar 9 19:55:19 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.3.0). 0.8.7.6 (ruby-2.3.0).
</div> </div>

11
doc/file.README.html
View File

@ -154,6 +154,11 @@ this example, the sequence has the fingerprint =
<blockquote> <blockquote>
<p>The sequence&#39;s fingerprint is “8bf70c23ac100cd2c3955081d8613325”,</p> <p>The sequence&#39;s fingerprint is “8bf70c23ac100cd2c3955081d8613325”,</p>
<blockquote>
<p>The fingerprint is generate by Digest::MD5 from the peptide sequence
“APDVQDCPECTLQENPFFSQPGAPILQCMGCCFSRAYPTPLRSKKTMLVQKNVTSESTCCVAKSYNRVTVMGGFKVENHTACHCSTCYYHKS”</p>
</blockquote>
<p>The output format is “json” (JSON).</p> <p>The output format is “json” (JSON).</p>
</blockquote> </blockquote>
</blockquote> </blockquote>
@ -174,7 +179,9 @@ href="http://www.daylight.com/dayhtml/doc/theory/theory.smiles.html">Daylight
SMILES</a> format, the <a SMILES</a> format, the <a
href="http://www.iupac.org/home/publications/e-resources/inchi.html">InChI</a> href="http://www.iupac.org/home/publications/e-resources/inchi.html">InChI</a>
format. Moreover, the compound can be represented with its <a format. Moreover, the compound can be represented with its <a
href="http://www.chem.qmul.ac.uk/iupac/">IUPAC name</a>.</p> href="http://www.chem.qmul.ac.uk/iupac/">IUPAC name</a>. The input can also
be of type <a href="https://en.wikipedia.org/wiki/FASTA_format">FASTA</a>,
which contains peptide or nucleotide sequences.</p>
</blockquote> </blockquote>
<h3 id="label-POST">POST</h3> <h3 id="label-POST">POST</h3>
@ -229,7 +236,7 @@ XML format.</p>
</div></div> </div></div>
<div id="footer"> <div id="footer">
Generated on Wed Mar 9 19:48:06 2016 by Generated on Wed Mar 9 19:55:20 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.3.0). 0.8.7.6 (ruby-2.3.0).
</div> </div>

11
doc/index.html
View File

@ -154,6 +154,11 @@ this example, the sequence has the fingerprint =
<blockquote> <blockquote>
<p>The sequence&#39;s fingerprint is “8bf70c23ac100cd2c3955081d8613325”,</p> <p>The sequence&#39;s fingerprint is “8bf70c23ac100cd2c3955081d8613325”,</p>
<blockquote>
<p>The fingerprint is generate by Digest::MD5 from the peptide sequence
“APDVQDCPECTLQENPFFSQPGAPILQCMGCCFSRAYPTPLRSKKTMLVQKNVTSESTCCVAKSYNRVTVMGGFKVENHTACHCSTCYYHKS”</p>
</blockquote>
<p>The output format is “json” (JSON).</p> <p>The output format is “json” (JSON).</p>
</blockquote> </blockquote>
</blockquote> </blockquote>
@ -174,7 +179,9 @@ href="http://www.daylight.com/dayhtml/doc/theory/theory.smiles.html">Daylight
SMILES</a> format, the <a SMILES</a> format, the <a
href="http://www.iupac.org/home/publications/e-resources/inchi.html">InChI</a> href="http://www.iupac.org/home/publications/e-resources/inchi.html">InChI</a>
format. Moreover, the compound can be represented with its <a format. Moreover, the compound can be represented with its <a
href="http://www.chem.qmul.ac.uk/iupac/">IUPAC name</a>.</p> href="http://www.chem.qmul.ac.uk/iupac/">IUPAC name</a>. The input can also
be of type <a href="https://en.wikipedia.org/wiki/FASTA_format">FASTA</a>,
which contains peptide or nucleotide sequences.</p>
</blockquote> </blockquote>
<h3 id="label-POST">POST</h3> <h3 id="label-POST">POST</h3>
@ -229,7 +236,7 @@ XML format.</p>
</div></div> </div></div>
<div id="footer"> <div id="footer">
Generated on Wed Mar 9 19:48:06 2016 by Generated on Wed Mar 9 19:55:20 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.3.0). 0.8.7.6 (ruby-2.3.0).
</div> </div>

2
doc/top-level-namespace.html
View File

@ -105,7 +105,7 @@
</div> </div>
<div id="footer"> <div id="footer">
Generated on Wed Mar 9 19:48:06 2016 by Generated on Wed Mar 9 19:55:20 2016 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7.6 (ruby-2.3.0). 0.8.7.6 (ruby-2.3.0).
</div> </div>