Skip to content

Commit

Permalink
docs: Add small docs and remove R install that don't work
Browse files Browse the repository at this point in the history
  • Loading branch information
lsetiawan committed Dec 21, 2024
1 parent 1f5d16d commit 95a41b6
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 4 deletions.
4 changes: 0 additions & 4 deletions pixi.toml
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,3 @@ depends-on = ["install-python"]
[feature.r.dependencies]
r = "4.*"
r-devtools = ">=2.4.5,<3"

[feature.r.tasks.install-r]
cmd = 'R -e "rextendr::document()"'
cwd = "r-phylo2vec"
30 changes: 30 additions & 0 deletions r-phylo2vec/README.md
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)
```

0 comments on commit 95a41b6

Please sign in to comment.