Skip to content

Commit

Permalink
Fixing readme/readme.rmd
Browse files Browse the repository at this point in the history
  • Loading branch information
GregJohnsonJr committed Nov 7, 2024
1 parent f52e9b6 commit c45262e
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 29 deletions.
4 changes: 1 addition & 3 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,6 @@ knitr::opts_chunk$set(
)
```

# clustur <a href="https://mothur.org/phylotypr/"><img src="man/figures/logo.png" align="right" height="138" alt="phylotypr website" /></a>

<!-- badges: start -->

[![R-CMD-check](https://github.com/SchlossLab/clustur/actions/workflows/check-full.yml/badge.svg)](https://github.com/SchlossLab/clustur/actions/workflows/check-full.yml)
Expand Down Expand Up @@ -64,4 +62,4 @@ To get started, look at the ["Getting started"](www.schlosslab.org/clustur/) pag
## Contributions

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!
tag. If you would like to contribute pull request are welcomed!
44 changes: 18 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,6 @@
---
output: github_document
---

<!-- README.md is generated from README.Rmd. Please edit that file -->



# clustur <a href="https://mothur.org/phylotypr/"><img src="man/figures/logo.png" align="right" height="138" alt="phylotypr website" /></a>

<!-- badges: start -->

[![R-CMD-check](https://github.com/SchlossLab/clustur/actions/workflows/check-full.yml/badge.svg)](https://github.com/SchlossLab/clustur/actions/workflows/check-full.yml)
Expand All @@ -19,42 +12,41 @@ output: github_document

## Overview

clustur was developed for two main reasons: to allow developers to easily create
pipelines with mothur code in R, and to give users a powerful clustering
algorithm from mothur without having to download it. Because clustur is built
using rcpp, it benefits from the speed of C++ and the usability of R.
Additionally, since clustur will be open source, developers can modify are
package as needed. This will not only help us continue to create high quality
packages, but will allow everyone to take advantage of the foundation that is
already built.


clustur was developed for two main reasons: to allow developers to
easily create pipelines with mothur code in R, and to give users a
powerful clustering algorithm from mothur without having to download it.
Because clustur is built using rcpp, it benefits from the speed of C++
and the usability of R. Additionally, since clustur will be open source,
developers can modify are package as needed. This will not only help us
continue to create high quality packages, but will allow everyone to
take advantage of the foundation that is already built.

## Installation

For the official release from CRAN you can use the standard `install.packages()`
function:
For the official release from CRAN you can use the standard
`install.packages()` function:

```r
``` r
# install via cran
install.packages("clustur")
library(clustur)
```

For the developmental version, you can use the `install_github()` function from
the {devtools} package
For the developmental version, you can use the `install_github()`
function from the {devtools} package

```r
``` r
# install via github
devtools::install_github("SchlossLab/clustur")
library(clustur)
```

## Getting Started

To get started, look at the ["Getting started"](www.schlosslab.org/clustur/) page.
To get started, look at the [“Getting
started”](www.schlosslab.org/clustur/) page.

## Contributions

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!
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!

0 comments on commit c45262e

Please sign in to comment.