Add README.md

waldronlab · Aug 7, 2024 · 05670ab · 05670ab
1 parent 5edd16d
commit 05670ab
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,16 @@
+# bedbaser
+
+bedbaser is an R api for [BEDbase](https://bedbase.org) that provides access
+to the [BEDbase API](https://api.bedbase.org) and includes convenience
+functions, such for creating GRanges and GRangesList objects.
+
+## Install bedbaser
+
+Install bedbaser using `BiocManager`.
+
+```
+if (!"BiocManager" %in% rownames(installed.packages())) {
+    install.packages("BiocManager")
+}
+BiocManager::install("bedbaser", dependencies = TRUE)
+```
diff --git a/vignettes/bedbaser.Rmd b/vignettes/bedbaser.Rmd
@@ -39,8 +39,7 @@ BiocManager::install("bedbaser", dependencies = TRUE)
 
 # Create a bedbaser api
 
-bedbaser uses the `r Biocpkg("AnVIL")` Service class to create a `BEDbase`
-api, which allows access to the API directly.
+bedbaser uses the `r Biocpkg("AnVIL")` Service class to expose the BEDbase API.
 
 ```{r bedbase}
 api <- bedbaser()