From c45262e81e2e155c408363aa2d42d4ad34761022 Mon Sep 17 00:00:00 2001 From: GregJohnsonJr Date: Thu, 7 Nov 2024 16:35:32 -0500 Subject: [PATCH] Fixing readme/readme.rmd --- README.Rmd | 4 +--- README.md | 44 ++++++++++++++++++-------------------------- 2 files changed, 19 insertions(+), 29 deletions(-) diff --git a/README.Rmd b/README.Rmd index 2d1fb45..5aa63fa 100644 --- a/README.Rmd +++ b/README.Rmd @@ -13,8 +13,6 @@ knitr::opts_chunk$set( ) ``` -# clustur phylotypr website - [![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) @@ -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! \ No newline at end of file diff --git a/README.md b/README.md index fa376b6..cb89746 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,6 @@ ---- -output: github_document ---- - - -# clustur phylotypr website - [![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) @@ -19,32 +12,30 @@ 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) @@ -52,9 +43,10 @@ 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!