Skip to content

Commit

Permalink
Spell checking fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
GregJohnsonJr committed Nov 11, 2024
1 parent 6b95116 commit 1262250
Show file tree
Hide file tree
Showing 11 changed files with 14 additions and 11 deletions.
6 changes: 3 additions & 3 deletions R/cluster.R
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#' Read distance matrices
#'
#' Read in distances from a file that is formatted with three columns for the
#' row, column, and distance of a sparse, square matrix or in a Phylip-formatted
#' row, column, and distance of a sparse, square matrix or in a phylip-formatted
#' distance matrix.
#'
#' @export
Expand Down Expand Up @@ -54,7 +54,7 @@ read_dist <- function(distance_file, count_table,
}


#' Cluster entitites together
#' Cluster entities together
#'
#' Clusters entities represented in a distance matrix and count table using
#' one of several algorithms and outputs information about the composition and
Expand Down Expand Up @@ -201,7 +201,7 @@ read_count <- function(count_table_path) {

#' Create Sparse Matrix
#'
#' Given a list of i indexs, j indexes, and distances values,
#' Given a list of i indexes, j indexes, and distances values,
#' we can create a sparse distance matrix for you. Each vector
#' must have the same size.
#' @param i_index A list of i indexes, must be numeric
Expand Down
2 changes: 1 addition & 1 deletion R/cluster_object-getters.R
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ get_bins <- function(cluster_data) {
#'
#' @export
#' @description
#' GetShared retuns the generated abundance `data.frame`
#' GetShared returns the generated abundance `data.frame`
#' from the `cluster()` function
#' @param cluster_data The output from the `cluster()` function.
#' @examples
Expand Down
2 changes: 1 addition & 1 deletion README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,6 @@ To get started, look at the ["Getting started"](https://www.schlosslab.org/clust

## Contributions

For feature request please visit the issue page in github and use the feature
For feature request please visit the issue page in GitHub and use the feature
tag. If you would like to contribute pull request are welcomed!

2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,5 +48,5 @@ started”](https://www.schlosslab.org/clustur/) page.

## Contributions

For feature request please visit the issue page in github and use the
For feature request please visit the issue page in GitHub and use the
feature tag. If you would like to contribute pull request are welcomed!
2 changes: 2 additions & 0 deletions cran-comments.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,5 @@
0 errors | 0 warnings | 1 note

* This is a new release.
* All of our projects use C++ 11 so we can continue to support older architectures.
* Build checks for macos-latest (devel), ubuntu-lastest (devel), windows-latest (devel), windows latest (4.1), ubuntu-latest (release), ubuntu-latest (oldrel-1), ubuntu-latest (oldrel-2), and ubuntu-latest (oldrel-3) are currently passing via GitHub Actions.
2 changes: 1 addition & 1 deletion man/cluster.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions man/clustur-package.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/create_sparse_matrix.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/get_abundance.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/read_dist.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion vignettes/clustur.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ knitr::opts_chunk$set(
## Background
clustur was developed to be similar to [mothur's cluster
function](https://mothur.org/wiki/cluster/) that was written in C++. In order to
cluster your data, users need to provide their own sparse or Phylip-formatted
cluster your data, users need to provide their own sparse or phylip-formatted
distance matrix. They also need to provide a count table that either comes from
mothur or that they create in R. Once these objects are built users can call the
`cluster()` function. We currently support 5 methods: opticlust (default) and
Expand Down

0 comments on commit 1262250

Please sign in to comment.