export documents

xieguigang · Jan 3, 2024 · 761d2fb · 761d2fb
1 parent 26849c3
commit 761d2fb
Show file tree

Hide file tree

Showing 5 changed files with 17 additions and 2 deletions.
diff --git a/Rscript/Library/MSI_app b/Rscript/Library/MSI_app
diff --git a/Rscript/Library/mzkit_app/@export/mzDeco.d.ts b/Rscript/Library/mzkit_app/@export/mzDeco.d.ts
@@ -72,6 +72,9 @@ declare namespace mzDeco {
      * @return a vector of the peak deconvolution data,
      *  in format of xcms peak table liked or mzkit @``T:BioNovoGene.Analytical.MassSpectrometry.Math.PeakFeature``
      *  data object.
+     *  
+     *  the result data vector may contains the rt shift data result, where you can get this shift
+     *  value via the ``rt.shift`` attribute name, rt shift data model is clr type: @``T:BioNovoGene.Analytical.MassSpectrometry.Math.RtShift``.
    */
    function mz_deco(ms1: any, tolerance?: any, baseline?: number, peak_width?: any, joint?: boolean, parallel?: boolean, dtw?: boolean, feature?: any, env?: object): object|object;
    /**

diff --git a/Rscript/Library/mzkit_app/man/mz_quantify/mzDeco/mzDeco/mz_deco.1 b/Rscript/Library/mzkit_app/man/mz_quantify/mzDeco/mzDeco/mz_deco.1
@@ -36,6 +36,9 @@ Chromatogram data deconvolution
 a vector of the peak deconvolution data,
  in format of xcms peak table liked or mzkit @\fBT:BioNovoGene.Analytical.MassSpectrometry.Math.PeakFeature\fR
  data object.
+
+ the result data vector may contains the rt shift data result, where you can get this shift
+ value via the \fBrt.shift\fR attribute name, rt shift data model is clr type: @\fBT:BioNovoGene.Analytical.MassSpectrometry.Math.RtShift\fR.
 .PP
 .SH SEE ALSO
 mzDeco

diff --git a/Rscript/Library/mzkit_app/vignettes/mz_quantify/mzDeco.html b/Rscript/Library/mzkit_app/vignettes/mz_quantify/mzDeco.html
@@ -106,6 +106,12 @@ <h1>mzDeco</h1>
     <a href="/vignettes/clr/BioNovoGene/Analytical/MassSpectrometry/Math/xcms2.html">xcms2: xcms2</a>
   </td>
   <td><p>the peak table format table file model of xcms version 2</p></td>
+</tr>
+<tr>
+  <td id="rt_shift">
+    <a href="/vignettes/clr/BioNovoGene/Analytical/MassSpectrometry/Math/RtShift.html">rt_shift: RtShift</a>
+  </td>
+  <td></td>
 </tr></tbody>
       </table>
       <table class="table-three-line">

diff --git a/Rscript/Library/mzkit_app/vignettes/mz_quantify/mzDeco/mz_deco.html b/Rscript/Library/mzkit_app/vignettes/mz_quantify/mzDeco/mz_deco.html
@@ -65,7 +65,10 @@ <h3>Value</h3>
 
         <p>a vector of the peak deconvolution data,<br />
  in format of xcms peak table liked or mzkit <a href="/vignettes/clr/BioNovoGene/Analytical/MassSpectrometry/Math/PeakFeature.html">PeakFeature</a><br />
- data object.</p><h4>clr value class</h4><ul><li><a href="/vignettes/clr/BioNovoGene/Analytical/MassSpectrometry/Math/PeakFeature.html">PeakFeature</a></li><li><a href="/vignettes/clr/BioNovoGene/Analytical/MassSpectrometry/Math/xcms2.html">xcms2</a></li></ul>
+ data object.</p>
+
+<p>the result data vector may contains the rt shift data result, where you can get this shift<br />
+ value via the <code>rt.shift</code> attribute name, rt shift data model is clr type: <a href="/vignettes/clr/BioNovoGene/Analytical/MassSpectrometry/Math/RtShift.html">RtShift</a>.</p><h4>clr value class</h4><ul><li><a href="/vignettes/clr/BioNovoGene/Analytical/MassSpectrometry/Math/PeakFeature.html">PeakFeature</a></li><li><a href="/vignettes/clr/BioNovoGene/Analytical/MassSpectrometry/Math/xcms2.html">xcms2</a></li></ul>
 
         <h3 style="display: block;">Examples</h3>