Skip to content

Commit

Permalink
updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
caseykneale committed Aug 2, 2019
1 parent 86a4f55 commit 61c1f67
Show file tree
Hide file tree
Showing 25 changed files with 33 additions and 24 deletions.
1 change: 1 addition & 0 deletions REQUIRE
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,4 @@ Documenter
DocumenterTools
Plots
StatsBase
Date
4 changes: 4 additions & 0 deletions docs/assets/documenter.css
View file
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,10 @@ img {
max-width: 100%;
}

video {
max-width: 100%;
}

table {
border-collapse: collapse;
margin: 1em 0;
Expand Down
2 changes: 1 addition & 1 deletion docs/man/AnomalyDetection/index.html
View file
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
<!DOCTYPE html>
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Anomaly Detection · ChemometricsTools</title><link href="https://cdnjs.cloudflare.com/ajax/libs/normalize/4.2.0/normalize.min.css" rel="stylesheet" type="text/css"/><link href="https://fonts.googleapis.com/css?family=Lato|Roboto+Mono" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.6.3/css/font-awesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/default.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL="../.."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.2.0/require.min.js" data-main="../../assets/documenter.js"></script><script src="../../siteinfo.js"></script><script src="../../../versions.js"></script><link href="../../assets/documenter.css" rel="stylesheet" type="text/css"/></head><body><nav class="toc"><h1>ChemometricsTools</h1><select id="version-selector" onChange="window.location.href=this.value" style="visibility: hidden"></select><form class="search" id="search-form" action="../../search/"><input id="search-query" name="q" type="text" placeholder="Search docs"/></form><ul><li><a class="toctext" href="../../">Home</a></li><li><span class="toctext">Demos</span><ul><li><a class="toctext" href="../../Demos/Transforms/">Transforms</a></li><li><a class="toctext" href="../../Demos/Pipelines/">Pipelines</a></li><li><a class="toctext" href="../../Demos/ClassificationExample/">Classification</a></li><li><a class="toctext" href="../../Demos/RegressionExample/">Regression</a></li><li><a class="toctext" href="../../Demos/SIPLS/">SIPLS</a></li><li><a class="toctext" href="../../Demos/CalibXfer/">Calibration Transfer</a></li><li><a class="toctext" href="../../Demos/CurveResolution/">Curve Resolution</a></li></ul></li><li><span class="toctext">API</span><ul><li><a class="toctext" href="../Preprocess/">Preprocessing</a></li><li><a class="toctext" href="../Transformations/">Transformations/Pipelines</a></li><li><a class="toctext" href="../Sampling/">Sampling</a></li><li><a class="toctext" href="../Training/">Training</a></li><li><a class="toctext" href="../TimeSeries/">Time Series</a></li><li><a class="toctext" href="../RegressionModels/">Regression Models</a></li><li><a class="toctext" href="../regressMetrics/">Regression Metrics</a></li><li><a class="toctext" href="../ClassificationModels/">Classification Models</a></li><li><a class="toctext" href="../classMetrics/">Classification Metrics</a></li><li><a class="toctext" href="../Trees/">Tree Methods</a></li><li><a class="toctext" href="../Ensemble/">Ensemble Models</a></li><li><a class="toctext" href="../Clustering/">Clustering</a></li><li><a class="toctext" href="../MultiWay/">MultiWay</a></li><li class="current"><a class="toctext" href>Anomaly Detection</a><ul class="internal"><li><a class="toctext" href="#Functions-1">Functions</a></li></ul></li><li><a class="toctext" href="../CurveResolution/">Curve Resolution</a></li><li><a class="toctext" href="../Stats/">Stats.</a></li><li><a class="toctext" href="../Dists/">Distance Measures</a></li><li><a class="toctext" href="../PSO/">PSO</a></li><li><a class="toctext" href="../GeneticAlgorithms/">Genetic Algorithms</a></li></ul></li><li><a class="toctext" href="../FullAPI/">Full API</a></li></ul></nav><article id="docs"><header><nav><ul><li>API</li><li><a href>Anomaly Detection</a></li></ul><a class="edit-page" href="https://github.com/caseykneale/ChemometricsTools.jl/blob/master/docs/src/man/AnomalyDetection.md"><span class="fa"></span> Edit on GitHub</a></nav><hr/><div id="topbar"><span>Anomaly Detection</span><a class="fa fa-bars" href="#"></a></div></header><h1><a class="nav-anchor" id="Anomaly-Detection-API-Reference-1" href="#Anomaly-Detection-API-Reference-1">Anomaly Detection API Reference</a></h1><p>ChemometricsTools has a few anomaly detection methods. Feel free to read the API below. If that&#39;s too abstract, check out the shoot-out example : <a href="https://github.com/caseykneale/ChemometricsTools/shootouts/AnomalyDetection.jl">AnomalyDetection</a></p><h2><a class="nav-anchor" id="Functions-1" href="#Functions-1">Functions</a></h2><section class="docstring"><div class="docstring-header"><a class="docstring-binding" id="ChemometricsTools.Hotelling-Tuple{Any,PCA}" href="#ChemometricsTools.Hotelling-Tuple{Any,PCA}"><code>ChemometricsTools.Hotelling</code></a> — <span class="docstring-category">Method</span>.</div><div><div><pre><code class="language-julia">Hotelling(X, pca::PCA; Quantile = 0.05, Variance = 1.0)</code></pre><p>Computes the hotelling Tsq and upper control limit cut off of a <code>pca</code> object using a specified <code>Quantile</code> and cumulative variance explained <code>Variance</code> for new or old data <code>X</code>.</p><p>A review of PCA-based statistical process monitoring methodsfor time-dependent, high-dimensional data. Bart De Ketelaere https://wis.kuleuven.be/stat/robust/papers/2013/deketelaere-review.pdf</p></div></div><a class="source-link" target="_blank" href="https://github.com/caseykneale/ChemometricsTools.jl/blob/10cb18d68d69682cfaa1ca9e307a0c1c16c3a365/src/AnomalyDetection.jl#L51-L59">source</a></section><section class="docstring"><div class="docstring-header"><a class="docstring-binding" id="ChemometricsTools.Leverage-Tuple{PCA}" href="#ChemometricsTools.Leverage-Tuple{PCA}"><code>ChemometricsTools.Leverage</code></a> — <span class="docstring-category">Method</span>.</div><div><div><pre><code class="language-julia">Leverage(pca::PCA)</code></pre><p>Calculates the leverage of samples in a <code>pca</code> object.</p></div></div><a class="source-link" target="_blank" href="https://github.com/caseykneale/ChemometricsTools.jl/blob/10cb18d68d69682cfaa1ca9e307a0c1c16c3a365/src/AnomalyDetection.jl#L82-L86">source</a></section><section class="docstring"><div class="docstring-header"><a class="docstring-binding" id="ChemometricsTools.Q-Tuple{Any,PCA}" href="#ChemometricsTools.Q-Tuple{Any,PCA}"><code>ChemometricsTools.Q</code></a> — <span class="docstring-category">Method</span>.</div><div><div><pre><code class="language-julia">Q(X, pca::PCA; Quantile = 0.95, Variance = 1.0)</code></pre><p>Computes the Q-statistic and upper control limit cut off of a <code>pca</code> object using a specified <code>Quantile</code> and cumulative variance explained <code>Variance</code> for new or old data <code>X</code>.</p><p>A review of PCA-based statistical process monitoring methodsfor time-dependent, high-dimensional data. Bart De Ketelaere https://wis.kuleuven.be/stat/robust/papers/2013/deketelaere-review.pdf</p></div></div><a class="source-link" target="_blank" href="https://github.com/caseykneale/ChemometricsTools.jl/blob/10cb18d68d69682cfaa1ca9e307a0c1c16c3a365/src/AnomalyDetection.jl#L91-L99">source</a></section><footer><hr/><a class="previous" href="../MultiWay/"><span class="direction">Previous</span><span class="title">MultiWay</span></a><a class="next" href="../CurveResolution/"><span class="direction">Next</span><span class="title">Curve Resolution</span></a></footer></article></body></html>
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Anomaly Detection · ChemometricsTools</title><link href="https://cdnjs.cloudflare.com/ajax/libs/normalize/4.2.0/normalize.min.css" rel="stylesheet" type="text/css"/><link href="https://fonts.googleapis.com/css?family=Lato|Roboto+Mono" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.6.3/css/font-awesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/default.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL="../.."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.2.0/require.min.js" data-main="../../assets/documenter.js"></script><script src="../../siteinfo.js"></script><script src="../../../versions.js"></script><link href="../../assets/documenter.css" rel="stylesheet" type="text/css"/></head><body><nav class="toc"><h1>ChemometricsTools</h1><select id="version-selector" onChange="window.location.href=this.value" style="visibility: hidden"></select><form class="search" id="search-form" action="../../search/"><input id="search-query" name="q" type="text" placeholder="Search docs"/></form><ul><li><a class="toctext" href="../../">Home</a></li><li><span class="toctext">Demos</span><ul><li><a class="toctext" href="../../Demos/Transforms/">Transforms</a></li><li><a class="toctext" href="../../Demos/Pipelines/">Pipelines</a></li><li><a class="toctext" href="../../Demos/ClassificationExample/">Classification</a></li><li><a class="toctext" href="../../Demos/RegressionExample/">Regression</a></li><li><a class="toctext" href="../../Demos/SIPLS/">SIPLS</a></li><li><a class="toctext" href="../../Demos/CalibXfer/">Calibration Transfer</a></li><li><a class="toctext" href="../../Demos/CurveResolution/">Curve Resolution</a></li></ul></li><li><span class="toctext">API</span><ul><li><a class="toctext" href="../Preprocess/">Preprocessing</a></li><li><a class="toctext" href="../Transformations/">Transformations/Pipelines</a></li><li><a class="toctext" href="../Sampling/">Sampling</a></li><li><a class="toctext" href="../Training/">Training</a></li><li><a class="toctext" href="../TimeSeries/">Time Series</a></li><li><a class="toctext" href="../RegressionModels/">Regression Models</a></li><li><a class="toctext" href="../regressMetrics/">Regression Metrics</a></li><li><a class="toctext" href="../ClassificationModels/">Classification Models</a></li><li><a class="toctext" href="../classMetrics/">Classification Metrics</a></li><li><a class="toctext" href="../Trees/">Tree Methods</a></li><li><a class="toctext" href="../Ensemble/">Ensemble Models</a></li><li><a class="toctext" href="../Clustering/">Clustering</a></li><li><a class="toctext" href="../MultiWay/">MultiWay</a></li><li class="current"><a class="toctext" href>Anomaly Detection</a><ul class="internal"><li><a class="toctext" href="#Functions-1">Functions</a></li></ul></li><li><a class="toctext" href="../CurveResolution/">Curve Resolution</a></li><li><a class="toctext" href="../Stats/">Stats.</a></li><li><a class="toctext" href="../Dists/">Distance Measures</a></li><li><a class="toctext" href="../PSO/">PSO</a></li><li><a class="toctext" href="../GeneticAlgorithms/">Genetic Algorithms</a></li></ul></li><li><a class="toctext" href="../FullAPI/">Full API</a></li></ul></nav><article id="docs"><header><nav><ul><li>API</li><li><a href>Anomaly Detection</a></li></ul><a class="edit-page" href="https://github.com/caseykneale/ChemometricsTools.jl/blob/master/docs/src/man/AnomalyDetection.md"><span class="fa"></span> Edit on GitHub</a></nav><hr/><div id="topbar"><span>Anomaly Detection</span><a class="fa fa-bars" href="#"></a></div></header><h1><a class="nav-anchor" id="Anomaly-Detection-API-Reference-1" href="#Anomaly-Detection-API-Reference-1">Anomaly Detection API Reference</a></h1><p>ChemometricsTools has a few anomaly detection methods. Feel free to read the API below. If that&#39;s too abstract, check out the shoot-out example : <a href="https://github.com/caseykneale/ChemometricsTools/shootouts/AnomalyDetection.jl">AnomalyDetection</a></p><h2><a class="nav-anchor" id="Functions-1" href="#Functions-1">Functions</a></h2><section class="docstring"><div class="docstring-header"><a class="docstring-binding" id="ChemometricsTools.Hotelling-Tuple{Any,PCA}" href="#ChemometricsTools.Hotelling-Tuple{Any,PCA}"><code>ChemometricsTools.Hotelling</code></a> — <span class="docstring-category">Method</span>.</div><div><div><pre><code class="language-julia">Hotelling(X, pca::PCA; Quantile = 0.05, Variance = 1.0)</code></pre><p>Computes the hotelling Tsq and upper control limit cut off of a <code>pca</code> object using a specified <code>Quantile</code> and cumulative variance explained <code>Variance</code> for new or old data <code>X</code>.</p><p>A review of PCA-based statistical process monitoring methodsfor time-dependent, high-dimensional data. Bart De Ketelaere https://wis.kuleuven.be/stat/robust/papers/2013/deketelaere-review.pdf</p></div></div></section><section class="docstring"><div class="docstring-header"><a class="docstring-binding" id="ChemometricsTools.Leverage-Tuple{PCA}" href="#ChemometricsTools.Leverage-Tuple{PCA}"><code>ChemometricsTools.Leverage</code></a> — <span class="docstring-category">Method</span>.</div><div><div><pre><code class="language-julia">Leverage(pca::PCA)</code></pre><p>Calculates the leverage of samples in a <code>pca</code> object.</p></div></div></section><section class="docstring"><div class="docstring-header"><a class="docstring-binding" id="ChemometricsTools.Q-Tuple{Any,PCA}" href="#ChemometricsTools.Q-Tuple{Any,PCA}"><code>ChemometricsTools.Q</code></a> — <span class="docstring-category">Method</span>.</div><div><div><pre><code class="language-julia">Q(X, pca::PCA; Quantile = 0.95, Variance = 1.0)</code></pre><p>Computes the Q-statistic and upper control limit cut off of a <code>pca</code> object using a specified <code>Quantile</code> and cumulative variance explained <code>Variance</code> for new or old data <code>X</code>.</p><p>A review of PCA-based statistical process monitoring methodsfor time-dependent, high-dimensional data. Bart De Ketelaere https://wis.kuleuven.be/stat/robust/papers/2013/deketelaere-review.pdf</p></div></div></section><footer><hr/><a class="previous" href="../MultiWay/"><span class="direction">Previous</span><span class="title">MultiWay</span></a><a class="next" href="../CurveResolution/"><span class="direction">Next</span><span class="title">Curve Resolution</span></a></footer></article></body></html>
Loading

0 comments on commit 61c1f67

Please sign in to comment.