Skip to content

Commit

Permalink
add change in viginettes
Browse files Browse the repository at this point in the history
  • Loading branch information
Dhihram committed Aug 16, 2024
1 parent 26d7585 commit 84fe5b9
Show file tree
Hide file tree
Showing 4 changed files with 21 additions and 9 deletions.
1 change: 1 addition & 0 deletions DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -22,3 +22,4 @@ Suggests:
tidyverse,
treeio
VignetteBuilder: knitr
Year: 2024
10 changes: 8 additions & 2 deletions docs/index.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -81,9 +81,15 @@ gg

### Package Utilization

This package will utilize: 1. Finding and clustering the monophylectic groups in the tree 2. Add the parameter of the clusters: `bootstrap_treshold`, `data_range`, and `samearea` 3. Keep the maximum monophylectic groups in the cluster identify
This part of package, `genclus` will utilize:

the `bootstrap_treshold` is the minimum bootstrap value to be considered as a cluster. The `data_range` is the range of the days to be considered as a cluster. The `samearea` is the boolean value to consider the same area as a cluster.
1. Finding and clustering the monophylectic groups in the tree

2. Add the parameter of the clusters: `bootstrap_treshold`, `data_range`, and `samearea`

3. Keep the maximum monophylectic groups in the cluster identify

The `bootstrap_treshold` is the minimum bootstrap value to be considered as a cluster. The `data_range` is the range of the days to be considered as a cluster. The `samearea` is the boolean value to consider the same area as a cluster.

```{r}
res <- genclus(tree, metat, bootstrap_threshold = 80, date_range = 30, samearea = TRUE)
Expand Down
15 changes: 10 additions & 5 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -416,12 +416,17 @@ <h3>Data</h3>
</div>
<div id="package-utilization" class="section level3">
<h3>Package Utilization</h3>
<p>This package will utilize: 1. Finding and clustering the
monophylectic groups in the tree 2. Add the parameter of the clusters:
<p>This part of package, <code>genclus</code> will utilize:</p>
<ol style="list-style-type: decimal">
<li><p>Finding and clustering the monophylectic groups in the
tree</p></li>
<li><p>Add the parameter of the clusters:
<code>bootstrap_treshold</code>, <code>data_range</code>, and
<code>samearea</code> 3. Keep the maximum monophylectic groups in the
cluster identify</p>
<p>the <code>bootstrap_treshold</code> is the minimum bootstrap value to
<code>samearea</code></p></li>
<li><p>Keep the maximum monophylectic groups in the cluster
identify</p></li>
</ol>
<p>The <code>bootstrap_treshold</code> is the minimum bootstrap value to
be considered as a cluster. The <code>data_range</code> is the range of
the days to be considered as a cluster. The <code>samearea</code> is the
boolean value to consider the same area as a cluster.</p>
Expand Down
4 changes: 2 additions & 2 deletions vignettes/cluster_generating.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ The goal of caIRA is to find the cluster based tree and metadata of the data.

## Installation

You can install the development version of caIRA from [GitHub](https://github.com/) with:
You can install the development version of `caIRA` from [GitHub](https://github.com/) with:

``` r
# install.packages("devtools")
Expand Down Expand Up @@ -68,7 +68,7 @@ gg

### Package Utilization

This package will utilize:
This part of package `genclus` will utilize:
1. Finding and clustering the monophylectic groups in the tree
2. Add the parameter of the clusters: `bootstrap_treshold`, `data_range`, and `samearea`
3. Keep the maximum monophylectic groups in the cluster identify
Expand Down

0 comments on commit 84fe5b9

Please sign in to comment.