Skip to content

Latest commit

 

History

History
77 lines (44 loc) · 2.68 KB

README.md

File metadata and controls

77 lines (44 loc) · 2.68 KB
Raw

ANTsRCore

R-CMD-check

The ANTsRCore package provides Rcpp bindings for the C++ biomedical image processing library ANTs. This package should not be used directly, as it is meant to provide the core functionality for the user-facing ANTsR package.


Installation

The package can be installed the pre-compiled binaries (fast) or from source.

Pre-compiled binaries

The fastest way to install ANTsRCore is from pre-compiled binaries made available on the Releases Page. Download the relevant version and install it from the command line:

R CMD INSTALL ANTsRCore_*.tgz

From source using devtools

To install ANTsRCore from source, you can use devtools to install the latest version of the code directly form GitHub. This should also automatically install the main dependencies.

devtools::install_github('ANTsX/ANTsR')

From source using R CMD INSTALL

Alternatively, you can clone and install ANTsRCore and its main dependency (ITKR), then install them as you would traditional R source packages.

First, clone the repositories:

$ git clone https://github.com/stnava/ITKR.git
$ git clone https://github.com/ANTsX/ANTsRCore.git

Install the package as follows:

$ R CMD INSTALL ITKR
$ R CMD INSTALL ANTsRCore

Usage

Functions from this package should never be exposed directly to any users. Instead, this package should always be wrapped by user-facing functions. All library functions can be found in the R/RcppExports.R file which is automatically generated during the build.


Developer notes

Using devtools to install and document the package is useful but requires rebuilding the package from scratch every time it's run. If you are going to develop on the package, it is best to install it with R CMD INSTALL.

All documentation is done through Rcpp within the cpp files in the src/ directory. New Rcpp functions are imported to R by adding the // [[Rcpp::export]] tag and then running Rcpp::compileAttributes(). You should never have to edit any R files directly.

Authors

Brian B. Avants (maintainer), Benjamin M. Kandel, Jeff T. Duda, Philip A. Cook, Nicholas J. Tustison

License

Apache License (>=2.0)


Contributing

If you have a question or feature request, please create an issue on GitHub. Any issues related to ANTsR should preferably be posted in that repository.