GitXplorerGitXplorer
f

rncl

public
9 stars
3 forks
10 issues

Commits

List of commits on branch main.
Verified
ff36e0a287402ad8e2abf9a29887a83593efe832

prepare for CRAN submission

ffmichonneau committed 2 years ago
Verified
b85c01bee9b3300afcee18d62937e9e3d648f49a

bump version in NEWS

ffmichonneau committed 3 years ago
Verified
ec4861b8d35e95cbbc357d7217de8e28a67eccb7

update README, fix links that generated NOTES

ffmichonneau committed 3 years ago
Verified
8dec85f44672f591f1543cf9b407c1c9ff95fb9b

prepare for release

ffmichonneau committed 3 years ago
Verified
32acf4d834ef9c3001a35ff6e9dad91f2a5e39c4

update NEWS and cran comments

ffmichonneau committed 5 years ago
Verified
3d121784cd97ee8edfebffe383f522c136656b29

documentation fixes

ffmichonneau committed 5 years ago

README

The README file for this repository.

Build Status Build status Research software impact

An R interface to the NEXUS Class Library

This R package provides an interface to the C++ library NCL. It can parse efficiently common file formats used to store phylogenetic trees, especially NEXUS and Newick files.

This package is primarily intended to be used by package developers as it extracts the elements needed to build R objects that represent the content of the file. For instance, phylobase uses rncl to extract trees and/or data stored in NEXUS and Newick files to create objects of class phylo4 or phylo4d.

The package however provides two functions for users: read_nexus_phylo() and read_newick_phylo(). They read NEXUS and Newick files respectively, and return (a valid) phylo or multiPhylo object from the package ape. These functions differ from those found in ape (respectively read.tree and read.nexus) as rncl functions can read trees with singletons, and missing branch lengths. However, rncl adheres to the NEXUS standards and only accepts tip labels without white spaces and tip labels cannot be duplicated in the same tree.

Development versions for Windows

Because this package contains some C++ code, it can be tricky to build if you are using Windows. Unless you need a feature only available on GitHub, install rncl from CRAN.

Otherwise, you can obtain a binary version from here (unless the AppVeyor badge on top is gray, in which case you can download an older version or come back in a few minutes, or red meaning the current version is broken and you need to get an older version). Once in appveyor, look for the file named rncl_X.Y.Z.zip where X.Y.Z represent the version number (e.g., rncl_0.4.0.zip). Then you can install this compiled version of the package directly from R.