forked from sbhattlab/phylo2vec
-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: Add small docs and remove R install that don't work
- Loading branch information
Showing
2 changed files
with
30 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
# r-phylo2vec | ||
|
||
**NOTE: This is currently in active development and APIs will change. Use at | ||
your own risk.** | ||
|
||
This directory contains the pylo2vec R codebase, which includes Rust binding | ||
setup. | ||
|
||
Open up `R` command line interactive mode within the pixi environment: | ||
|
||
```console | ||
pixi run -e r-phylo2vec R --interactive | ||
``` | ||
|
||
Once in R, you can run the following to start using the package: | ||
|
||
```R | ||
# Install rextendr if not already installed | ||
install.packages("rextendr") | ||
|
||
# Install phylo2vec package | ||
rextendr::document('./r-phylo2vec') | ||
|
||
# Import the library | ||
library('phylo2vec') | ||
|
||
# A small demo | ||
v = sample(5, FALSE) | ||
to_newick(v) | ||
``` |