clean up readme

bcbio · Apr 16, 2024 · b378d8d · b378d8d
1 parent 06c9d4f
commit b378d8d
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 45 deletions.
diff --git a/README.Rmd b/README.Rmd
@@ -2,22 +2,13 @@
 output: github_document
 ---
 
-```{r, include = FALSE}
-knitr::opts_chunk$set(
-  collapse = TRUE,
-  comment = "#>",
-  fig.path = "man/figures/README-",
-  out.width = "100%"
-)
-```
-
 # bcbioR
 
 <!-- badges: start -->
   [![R-CMD-check](https://github.com/bcbio/bcbioR/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/bcbio/bcbioR/actions/workflows/R-CMD-check.yaml)
   <!-- badges: end -->
 
-The goal of bcbioR is to ...
+The goal of bcbioR is to create guidelines for NGS data interpretation based on the experience of the Harvard Chan Bioinformatics Core and everybody who wants to contribute.
 
 ## Installation
 
@@ -30,25 +21,14 @@ devtools::install_github("bcbio/bcbioR")
 
 ## Example
 
-This is a basic example which shows you how to solve a common problem:
 
 ```{r example}
 library(bcbioR)
 ## basic example code
 ```
 
-What is special about using `README.Rmd` instead of just `README.md`? You can include R chunks like so:
-
-```{r cars}
-summary(cars)
-```
+## How to Contribute
 
 You'll still need to render `README.Rmd` regularly, to keep `README.md` up-to-date. `devtools::build_readme()` is handy for this.
 
-You can also embed plots, for example:
-
-```{r pressure, echo = FALSE}
-plot(pressure)
-```
-
-In that case, don't forget to commit and push the resulting figure files, so they display on GitHub and CRAN.
+Don't forget to commit and push the resulting figure files, so they display on GitHub and CRAN.
diff --git a/README.md b/README.md
@@ -6,7 +6,9 @@
 [![R-CMD-check](https://github.com/bcbio/bcbioR/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/bcbio/bcbioR/actions/workflows/R-CMD-check.yaml)
 <!-- badges: end -->
 
-The goal of bcbioR is to …
+The goal of bcbioR is to create guidelines for NGS data interpretation
+based on the experience of the Harvard Chan Bioinformatics Core and
+everybody who wants to contribute.
 
 ## Installation
 
@@ -20,33 +22,15 @@ devtools::install_github("bcbio/bcbioR")
 
 ## Example
 
-This is a basic example which shows you how to solve a common problem:
-
 ``` r
 library(bcbioR)
 ## basic example code
 ```
 
-What is special about using `README.Rmd` instead of just `README.md`?
-You can include R chunks like so:
-
-``` r
-summary(cars)
-#>      speed           dist       
-#>  Min.   : 4.0   Min.   :  2.00  
-#>  1st Qu.:12.0   1st Qu.: 26.00  
-#>  Median :15.0   Median : 36.00  
-#>  Mean   :15.4   Mean   : 42.98  
-#>  3rd Qu.:19.0   3rd Qu.: 56.00  
-#>  Max.   :25.0   Max.   :120.00
-```
+## How to Contribute
 
 You’ll still need to render `README.Rmd` regularly, to keep `README.md`
 up-to-date. `devtools::build_readme()` is handy for this.
 
-You can also embed plots, for example:
-
-<img src="man/figures/README-pressure-1.png" width="100%" />
-
-In that case, don’t forget to commit and push the resulting figure
-files, so they display on GitHub and CRAN.
+Don’t forget to commit and push the resulting figure files, so they
+display on GitHub and CRAN.