Skip to content

Commit

Permalink
doc files are now a web site.
Browse files Browse the repository at this point in the history
  • Loading branch information
mhahsler committed May 15, 2024
1 parent 3e3de8f commit a694b45
Show file tree
Hide file tree
Showing 541 changed files with 5,357 additions and 5,081 deletions.
6 changes: 3 additions & 3 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,9 @@ Here are some quick guides on applications of seriation:

Implemented seriation methods and criteria:

* [Documentation of the implemented seriation methods](https://mhahsler.github.io/seriation/seriation_methods.html)
* [Documentation of the implemented seriation criteria](https://mhahsler.github.io/seriation/seriation_criteria.html)
* [A visual comparison between seriation methods](https://mhahsler.github.io/seriation/visual_comparison.html)
* [Documentation of the implemented seriation methods](https://mhahsler.github.io/seriation/_site/seriation_methods.html)
* [Documentation of the implemented seriation criteria](https://mhahsler.github.io/seriation/_site/seriation_criteria.html)
* [A visual comparison between seriation methods](https://mhahsler.github.io/seriation/_site/comparison.html)

```{r echo=FALSE, results = 'asis'}
pkg_usage(pkg)
Expand Down
1 change: 1 addition & 0 deletions docs/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
/.quarto/
43 changes: 43 additions & 0 deletions docs/_quarto.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
project:
type: website
render:
- seriation_methods.qmd
- seriation_criteria.qmd
- heatmaps.qmd
- correlation_matrix.qmd
- clustering.qmd
- comparison.qmd

website:
title: "R Package Seriation"
sidebar:
style: "docked"
search: true
contents:
- section: "Package"
contents:
- text: Package Overview
href: https://github.com/mhahsler/seriation
- section: "Methods and Criteria"
contents:
- text: Methods
href: seriation_methods.qmd
- text: Criteria
href: seriation_criteria.qmd
- text: Comparison
href: comparison.qmd
- section: "Quick Guides"
contents:
- text: Introduction
href: https://cran.r-project.org/web/packages/seriation/vignettes/seriation.pdf
- text: How to reorder heatmaps
href: heatmaps.qmd
- text: How to reorder correlation matrices
href: correlation_matrix.qmd
- text: How to evaluate clusters using dissimilarity plots
href: clustering.qmd

format:
html:
theme: cosmo
toc: true
684 changes: 684 additions & 0 deletions docs/_site/clustering.html

Large diffs are not rendered by default.

437 changes: 289 additions & 148 deletions docs/visual_comparison.html → docs/_site/comparison.html

Large diffs are not rendered by default.

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
207 changes: 176 additions & 31 deletions docs/correlation_matrix.html → docs/_site/correlation_matrix.html

Large diffs are not rendered by default.

928 changes: 928 additions & 0 deletions docs/_site/heatmaps.html

Large diffs are not rendered by default.

8 changes: 8 additions & 0 deletions docs/_site/index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>Redirect to seriation_methods.html</title>
<meta http-equiv="refresh" content="0;URL='seriation_methods.html'" />
</head>
<body>
</body>
</html>
268 changes: 268 additions & 0 deletions docs/_site/search.json

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

<meta name="author" content="Michael Hahsler">

<title>How to Evaluate Clusters Using Dissimilarity Plots</title>
<title>R Package Seriation - How to Evaluate Clusters Using Dissimilarity Plots</title>
<style>
code{white-space: pre-wrap;}
span.smallcaps{font-variant: small-caps;}
Expand Down Expand Up @@ -58,28 +58,166 @@
</style>


<script src="seriation_cluster_evaluation_files/libs/clipboard/clipboard.min.js"></script>
<script src="seriation_cluster_evaluation_files/libs/quarto-html/quarto.js"></script>
<script src="seriation_cluster_evaluation_files/libs/quarto-html/popper.min.js"></script>
<script src="seriation_cluster_evaluation_files/libs/quarto-html/tippy.umd.min.js"></script>
<script src="seriation_cluster_evaluation_files/libs/quarto-html/anchor.min.js"></script>
<link href="seriation_cluster_evaluation_files/libs/quarto-html/tippy.css" rel="stylesheet">
<link href="seriation_cluster_evaluation_files/libs/quarto-html/quarto-syntax-highlighting.css" rel="stylesheet" id="quarto-text-highlighting-styles">
<script src="seriation_cluster_evaluation_files/libs/bootstrap/bootstrap.min.js"></script>
<link href="seriation_cluster_evaluation_files/libs/bootstrap/bootstrap-icons.css" rel="stylesheet">
<link href="seriation_cluster_evaluation_files/libs/bootstrap/bootstrap.min.css" rel="stylesheet" id="quarto-bootstrap" data-mode="light">
<script src="site_libs/quarto-nav/quarto-nav.js"></script>
<script src="site_libs/quarto-nav/headroom.min.js"></script>
<script src="site_libs/clipboard/clipboard.min.js"></script>
<script src="site_libs/quarto-search/autocomplete.umd.js"></script>
<script src="site_libs/quarto-search/fuse.min.js"></script>
<script src="site_libs/quarto-search/quarto-search.js"></script>
<meta name="quarto:offset" content="./">
<script src="site_libs/quarto-html/quarto.js"></script>
<script src="site_libs/quarto-html/popper.min.js"></script>
<script src="site_libs/quarto-html/tippy.umd.min.js"></script>
<script src="site_libs/quarto-html/anchor.min.js"></script>
<link href="site_libs/quarto-html/tippy.css" rel="stylesheet">
<link href="site_libs/quarto-html/quarto-syntax-highlighting.css" rel="stylesheet" id="quarto-text-highlighting-styles">
<script src="site_libs/bootstrap/bootstrap.min.js"></script>
<link href="site_libs/bootstrap/bootstrap-icons.css" rel="stylesheet">
<link href="site_libs/bootstrap/bootstrap.min.css" rel="stylesheet" id="quarto-bootstrap" data-mode="light">
<script id="quarto-search-options" type="application/json">{
"location": "sidebar",
"copy-button": false,
"collapse-after": 3,
"panel-placement": "start",
"type": "textbox",
"limit": 20,
"language": {
"search-no-results-text": "No results",
"search-matching-documents-text": "matching documents",
"search-copy-link-title": "Copy link to search",
"search-hide-matches-text": "Hide additional matches",
"search-more-match-text": "more match in this document",
"search-more-matches-text": "more matches in this document",
"search-clear-button-title": "Clear",
"search-detached-cancel-button-title": "Cancel",
"search-submit-button-title": "Submit",
"search-label": "Search"
}
}</script>

<script src="https://polyfill.io/v3/polyfill.min.js?features=es6"></script>
<script src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-chtml-full.js" type="text/javascript"></script>

<link rel="stylesheet" href="styles.css">
</head>

<body>
<body class="nav-sidebar docked">

<div id="quarto-content" class="page-columns page-rows-contents page-layout-article">
<div id="quarto-margin-sidebar" class="sidebar margin-sidebar">
<nav id="TOC" role="doc-toc" class="toc-active">
<h2 id="toc-title">Table of contents</h2>
<div id="quarto-search-results"></div>
<header id="quarto-header" class="headroom fixed-top">
<nav class="quarto-secondary-nav">
<div class="container-fluid d-flex">
<button type="button" class="quarto-btn-toggle btn" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar,#quarto-sidebar-glass" aria-controls="quarto-sidebar" aria-expanded="false" aria-label="Toggle sidebar navigation" onclick="if (window.quartoToggleHeadroom) { window.quartoToggleHeadroom(); }">
<i class="bi bi-layout-text-sidebar-reverse"></i>
</button>
<nav class="quarto-page-breadcrumbs" aria-label="breadcrumb"><ol class="breadcrumb"><li class="breadcrumb-item"><a href="https://cran.r-project.org/web/packages/seriation/vignettes/seriation.pdf">Quick Guides</a></li><li class="breadcrumb-item"><a href="./seriation_cluster_evaluation.html">How to evaluate clusters using dissimilarity plots</a></li></ol></nav>
<a class="flex-grow-1" role="button" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar,#quarto-sidebar-glass" aria-controls="quarto-sidebar" aria-expanded="false" aria-label="Toggle sidebar navigation" onclick="if (window.quartoToggleHeadroom) { window.quartoToggleHeadroom(); }">
</a>
<button type="button" class="btn quarto-search-button" aria-label="" onclick="window.quartoOpenSearch();">
<i class="bi bi-search"></i>
</button>
</div>
</nav>
</header>
<!-- content -->
<div id="quarto-content" class="quarto-container page-columns page-rows-contents page-layout-article">
<!-- sidebar -->
<nav id="quarto-sidebar" class="sidebar collapse collapse-horizontal sidebar-navigation docked overflow-auto">
<div class="pt-lg-2 mt-2 text-left sidebar-header">
<div class="sidebar-title mb-0 py-0">
<a href="./">R Package Seriation</a>
</div>
</div>
<div class="mt-2 flex-shrink-0 align-items-center">
<div class="sidebar-search">
<div id="quarto-search" class="" title="Search"></div>
</div>
</div>
<div class="sidebar-menu-container">
<ul class="list-unstyled mt-1">
<li class="sidebar-item sidebar-item-section">
<div class="sidebar-item-container">
<a class="sidebar-item-text sidebar-link text-start" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar-section-1" aria-expanded="true">
<span class="menu-text">Package</span></a>
<a class="sidebar-item-toggle text-start" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar-section-1" aria-expanded="true" aria-label="Toggle section">
<i class="bi bi-chevron-right ms-2"></i>
</a>
</div>
<ul id="quarto-sidebar-section-1" class="collapse list-unstyled sidebar-section depth1 show">
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="./.." class="sidebar-item-text sidebar-link">
<span class="menu-text">Package Overview</span></a>
</div>
</li>
</ul>
</li>
<li class="sidebar-item sidebar-item-section">
<div class="sidebar-item-container">
<a class="sidebar-item-text sidebar-link text-start" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar-section-2" aria-expanded="true">
<span class="menu-text">Methods and Criteria</span></a>
<a class="sidebar-item-toggle text-start" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar-section-2" aria-expanded="true" aria-label="Toggle section">
<i class="bi bi-chevron-right ms-2"></i>
</a>
</div>
<ul id="quarto-sidebar-section-2" class="collapse list-unstyled sidebar-section depth1 show">
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="./seriation_methods.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Methods</span></a>
</div>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="./seriation_criteria.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">Criteria</span></a>
</div>
</li>
</ul>
</li>
<li class="sidebar-item sidebar-item-section">
<div class="sidebar-item-container">
<a class="sidebar-item-text sidebar-link text-start" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar-section-3" aria-expanded="true">
<span class="menu-text">Quick Guides</span></a>
<a class="sidebar-item-toggle text-start" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar-section-3" aria-expanded="true" aria-label="Toggle section">
<i class="bi bi-chevron-right ms-2"></i>
</a>
</div>
<ul id="quarto-sidebar-section-3" class="collapse list-unstyled sidebar-section depth1 show">
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="https://cran.r-project.org/web/packages/seriation/vignettes/seriation.pdf" class="sidebar-item-text sidebar-link">
<span class="menu-text">Introduction</span></a>
</div>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="./heatmaps.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">How to reorder heatmaps</span></a>
</div>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="./correlation_matrix.html" class="sidebar-item-text sidebar-link">
<span class="menu-text">How to reorder correlation matrices</span></a>
</div>
</li>
<li class="sidebar-item">
<div class="sidebar-item-container">
<a href="./seriation_cluster_evaluation.html" class="sidebar-item-text sidebar-link active">
<span class="menu-text">How to evaluate clusters using dissimilarity plots</span></a>
</div>
</li>
</ul>
</li>
</ul>
</div>
</nav>
<div id="quarto-sidebar-glass" data-bs-toggle="collapse" data-bs-target="#quarto-sidebar,#quarto-sidebar-glass"></div>
<!-- margin-sidebar -->
<div id="quarto-margin-sidebar" class="sidebar margin-sidebar">
<nav id="TOC" role="doc-toc" class="toc-active">
<h2 id="toc-title">On this page</h2>

<ul>
<li><a href="#introduction" id="toc-introduction" class="nav-link active" data-scroll-target="#introduction">Introduction</a></li>
Expand All @@ -92,7 +230,8 @@ <h2 id="toc-title">Table of contents</h2>
<li><a href="#references" id="toc-references" class="nav-link" data-scroll-target="#references">References</a></li>
</ul>
</nav>
</div>
</div>
<!-- main -->
<main class="content" id="quarto-document-content">

<header id="title-block-header" class="quarto-title-block default">
Expand Down Expand Up @@ -295,10 +434,11 @@ <h2 class="anchored" data-anchor-id="references">References</h2>
<ul>
<li>Hahsler, M. and Hornik, K. (2011): Dissimilarity plots: A visual exploration tool for partitional clustering. <em>Journal of Computational and Graphical Statistics,</em> <strong>10</strong>(2):335–354. <a href="http://dx.doi.org/10.1198/jcgs.2010.09139">doi:10.1198/jcgs.2010.09139</a> (read the <a href="http://michael.hahsler.net/research/paper/dissplot_JCGS2011_preprint.pdf">preprint</a>)</li>
</ul>


</section>

</main>
<!-- /main column -->
</main> <!-- /main -->
<script id="quarto-html-after-body" type="application/javascript">
window.document.addEventListener("DOMContentLoaded", function (event) {
const toggleBodyColorMode = (bsSheetEl) => {
Expand Down
Loading

0 comments on commit a694b45

Please sign in to comment.