Skip to content

Commit 9e50aaf

Browse files
author
Hajk-Georg Drost
committed
update README
1 parent 62fdf0f commit 9e50aaf

File tree

1 file changed

+19
-23
lines changed

1 file changed

+19
-23
lines changed

README.md

Lines changed: 19 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,18 @@
11
# metablastr
22

3-
## A [BLAST](https://blast.ncbi.nlm.nih.gov/Blast.cgi) interface with R
3+
## Seamless Integration of [BLAST](https://blast.ncbi.nlm.nih.gov/Blast.cgi) Sequence Searches in R
44

55
### Motivation
66

7-
The exponentially growing number of available sequences in biological databases
8-
revolutionizes the way modern life science research is conducted. Approximately
9-
hundred thousand genomic sequences spanning diverse species from the tree of life
10-
are currently publically available and free to access. It is now possible to
11-
access and retrieve this data automatically using the R package [biomartr](https://github.com/ropensci/biomartr)
12-
and the next step is to harness this wealth of sequence diversity to explore
13-
and detect novel patterns of evolvability, variation, and disease emergence.
7+
With the rapid expansion of available sequences in biological databases, the landscape of modern life science research is being transformed. Currently, around several hundred thousand genomic sequences from a diverse array of species in the tree of life are freely accessible to the public. The R package [biomartr](https://github.com/ropensci/biomartr) enables automated access and retrieval of this vast data, paving the way to delve into the rich tapestry of sequence diversity, uncovering new insights into evolvability, variation, and the emergence of diseases.
148

15-
The R package [biomartr](https://github.com/ropensci/biomartr)
16-
__solves the problem of retrieving this vast amount of biological sequence data__ in a standardized and computationally reproducible way and
17-
the `metablastr` package aims to __solve the problem of performing massive scale
18-
sequence searches__ in a standardized and computationally reproducible way.
9+
The [biomartr](https://github.com/ropensci/biomartr) package streamlines the retrieval of a massive amount of biological sequence data in a standardized and reproducible manner. Complementing it, the `metablastr` package is tailored to facilitate large-scale sequence searches, also in a standardized and reproducible approach.
1910

20-
Both packages, `biomartr` and `metablastr` are designed to complement
21-
each other seamlessly to provide users with a toolset to automatically
22-
retrieve thousands of biological sequences (thousands of genomes, proteomes, annotations, etc)
23-
and to use these sequences to perform massive sequence searches with [BLAST](https://blast.ncbi.nlm.nih.gov/Blast.cgi) to
24-
extract novel patterns of similarity and divergence between large sets
25-
of species.
11+
In synergy, [biomartr](https://github.com/ropensci/biomartr) and `metablastr` provide researchers with a comprehensive toolset, allowing them to efficiently gather thousands of biological sequences (genomes, proteomes, annotations, etc.) and conduct extensive sequence comparisons using the gold standard sequence search engine [BLAST](https://blast.ncbi.nlm.nih.gov/Blast.cgi). This facilitates the extraction of novel patterns highlighting similarities and divergences among vast sets of species.
2612

27-
The most prominent tool to perform sequence searches at scale is the Basic Local Alignment Search Tool (BLAST)
28-
which is designed to find regions of sequence similarity between query and a subject sequences or sequence databases.
13+
It's worth noting that the go-to instrument for large-scale sequence searches is BLAST (Basic Local Alignment Search Tool). It is purposefully built to identify regions of sequence similarity between a given query and subject sequences or sequence databases.
2914

15+
Building on these advancements, we have recently introduced [DIAMOND2](https://www.nature.com/articles/s41592-021-01101-x), a groundbreaking software solution designed to accelerate `BLAST` searches by an factor of up to 10,000x. To offer researchers even more flexibility and integration, we provide [rdiamond](https://github.com/drostlab/rdiamond), a dedicated interface package that allows programmatic handling of [DIAMOND2](https://github.com/bbuchfink/diamond) sequence searches directly through R. This not only streamlines the sequence search process but also ensures that researchers can access and utilize the power of [DIAMOND2](https://github.com/bbuchfink/diamond) within a familiar R environment.
3016

3117
### Short package description
3218

@@ -56,15 +42,25 @@ sudo apt-get install libpq-dev
5642
### For all systems install `metablastr` by typing
5743

5844
```r
45+
# install BiocManager if required
5946
if (!requireNamespace("BiocManager", quietly = TRUE))
6047
install.packages("BiocManager")
6148
BiocManager::install()
6249

63-
BiocManager::install(c("Biostrings", "GenomicFeatures", "GenomicRanges", "Rsamtools", "IRanges", "rtracklayer", "biomaRt"))
50+
# install package dependencies
51+
BiocManager::install(
52+
c(
53+
"Biostrings",
54+
"GenomicFeatures",
55+
"GenomicRanges",
56+
"Rsamtools",
57+
"IRanges",
58+
"rtracklayer")
59+
)
6460

6561
# install.packages("devtools")
6662
# install the current version of metablastr on your system
67-
devtools::install_github("HajkD/metablastr", build_vignettes = TRUE, dependencies = TRUE)
63+
devtools::install_github("drostlab/metablastr", build_vignettes = TRUE, dependencies = TRUE)
6864
```
6965

7066
__Please follow the [Installation Vignette](https://drostlab.github.io/metablastr/articles/installation.html) to install all standalone sequence search tools.__
@@ -110,7 +106,7 @@ I would be very happy to learn more about potential improvements of the concepts
110106

111107
Furthermore, in case you find some bugs, need additional (more flexible) functionality of parts of this package, or want to contribute to this project please let me know:
112108

113-
https://github.com/HajkD/metablastr/issues
109+
https://github.com/drostlab/metablastr/issues
114110

115111

116112
## Interfaces implemented in `metablastr`:

0 commit comments

Comments
 (0)