Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
trvinh committed Jul 14, 2021
1 parent cbfcee8 commit 9c68782
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,25 @@ Feature-aware phylogenetic profile of the yeast ribosome biogenesis genes across
* The color scheme represents the similarity of annotated features between yeast proteins and the respective orthologs using the FAS scores ([Koestler, et al. 2010](https://bmcbioinformatics.biomedcentral.com/articles/10.1186/1471-2105-11-417)) by assigning values between 0 and 1. The score is penalized for missing features (FAS_F; dot color) and added features (FAS_B; background color) in the orthologous protein. For instance, a protein with an identical feature architecture to the reference protein in yeast would have FAS_F = 1 and FAS_B = 1, and would appear as a blue dot in a white background according to the color scale.
* For further details on the biological interpretation of the data, please refer to the article [DO WE HAVE A PRE-PRINT SOMEWHERE](https://www.biorxiv.org/content/10.1101/2021.01.29.428808v2).

# Standalone installation

From an R terminal, PhyloRBF can be installed locally using *devtools*:

```r
if (!requireNamespace("devtools"))
install.packages("devtools")
devtools::install_github("BIONF/PhyloProfile", INSTALL_opts = c('--no-lock'), build_vignettes = TRUE)
```

Then, to run it, enter:

```r
library(PhyloRBF)
runPhyloRBF()
```

Check your web browser, *PhyloRBF* will be displayed there ;-) For the first time running, the tool will download some pre-calculated data. Please be patient until you see a the profile plot.

# Bugs
Any bug reports or comments, suggestions are highly appreciated. Please [open an issue on GitHub](https://github.com/BIONF/PhyloRBF/issues/new) or be in touch via email.

Expand Down
Binary file modified phyloprofile_interface.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 9c68782

Please sign in to comment.