Skip to content

Commit

Permalink
Updating description, news and README
Browse files Browse the repository at this point in the history
  • Loading branch information
jonclayden committed Sep 10, 2020
1 parent c04806e commit e9b8e18
Show file tree
Hide file tree
Showing 4 changed files with 25 additions and 11 deletions.
18 changes: 9 additions & 9 deletions DESCRIPTION
@@ -1,15 +1,15 @@
Package: RNiftyReg
Version: 2.6.8
Date: 2020-03-31
Version: 2.7.0
Date: 2020-09-10
Title: Image Registration Using the 'NiftyReg' Library
Authors@R: c(person("Jon","Clayden",role=c("cre","aut"),email="code@clayden.org"),
person("Marc","Modat",role="aut"),
person("Benoit","Presles",role="aut"),
person("Thanasis","Anthopoulos",role="aut"),
person("Pankaj","Daga",role="aut"))
Authors@R: c(person("Jon", "Clayden", role=c("cre","aut"), email="code@clayden.org", comment=c(ORCID="0000-0002-6608-0619")),
person("Marc", "Modat", role="aut"),
person("Benoit", "Presles", role="aut"),
person("Thanasis", "Anthopoulos", role="aut"),
person("Pankaj", "Daga", role="aut"))
Maintainer: Jon Clayden <code@clayden.org>
Imports: Rcpp (>= 0.11.0), RNifti (>= 0.4.0), ore
Suggests: jpeg, loder, mmand, testthat (>= 0.11.0), covr
Imports: Rcpp, RNifti, ore
Suggests: jpeg, loder, mmand, testthat, covr
LinkingTo: Rcpp, RcppEigen, RNifti
Description: Provides an 'R' interface to the 'NiftyReg' image registration tools
<http://sourceforge.net/projects/niftyreg/>. Linear and nonlinear registration
Expand Down
14 changes: 14 additions & 0 deletions NEWS
Expand Up @@ -2,6 +2,20 @@ Significant changes to the RNiftyReg package are laid out below for each release

=================================================================================

VERSION 2.7.0

- New functions saveTransform() and loadTransform() allow a linear transform to
be serialised, complete with source and target image metadata, into a single
compact RDS file. This does not yet work with nonlinear transforms, because
of their more complex metadata. (Suggested by Yves Rozenholc and Christine
Keribin.)
- There is now an asNifti() method for "niftyreg" objects, for use with RNifti
version 1.2.0 and above. This allows, for example, writeNifti() to be called
directly on the result of a registration. (Suggested by @charleswg, issue
#10.)

=================================================================================

VERSION 2.6.8

- Mask images without a valid "qform" would lead to inaccurate resampling and
Expand Down
2 changes: 1 addition & 1 deletion README.Rmd
Expand Up @@ -7,7 +7,7 @@ knitr::opts_chunk$set(collapse=TRUE, fig.path="tools/figures/", dpi=150, fig.dim

# RNiftyReg: Nifty Registration in R

The `RNiftyReg` package is an R-native interface to the [NiftyReg image registration library](http://sourceforge.net/projects/niftyreg/) developed within the Translational Imaging Group at University College London. The package incorporates the library, so it does not need to be installed separately, and it replaces the NiftyReg command-line front-end with a direct, in-memory bridge to R, based on [Rcpp](http://www.rcpp.org).
The `RNiftyReg` package is an R-native interface to the [NiftyReg image registration library](https://github.com/KCL-BMEIS/niftyreg). The package incorporates the library, so it does not need to be installed separately, and it replaces the NiftyReg command-line front-end with a direct, in-memory bridge to R, based on [the `RNifti` package](https://github.com/jonclayden/RNifti).

This `README` file primarily covers version 2.0.0 of the package and later. The interface was substantially reworked in that version to make it more natural and less verbose, and earlier versions are incompatible. Information on [moving from prior versions of `RNiftyReg` to 2.x](#upgrading-to-rniftyreg-2x) is included at the end of this file.

Expand Down
2 changes: 1 addition & 1 deletion README.md
Expand Up @@ -4,7 +4,7 @@

# RNiftyReg: Nifty Registration in R

The `RNiftyReg` package is an R-native interface to the [NiftyReg image registration library](http://sourceforge.net/projects/niftyreg/) developed within the Translational Imaging Group at University College London. The package incorporates the library, so it does not need to be installed separately, and it replaces the NiftyReg command-line front-end with a direct, in-memory bridge to R, based on [Rcpp](http://www.rcpp.org).
The `RNiftyReg` package is an R-native interface to the [NiftyReg image registration library](https://github.com/KCL-BMEIS/niftyreg). The package incorporates the library, so it does not need to be installed separately, and it replaces the NiftyReg command-line front-end with a direct, in-memory bridge to R, based on [the `RNifti` package](https://github.com/jonclayden/RNifti).

This `README` file primarily covers version 2.0.0 of the package and later. The interface was substantially reworked in that version to make it more natural and less verbose, and earlier versions are incompatible. Information on [moving from prior versions of `RNiftyReg` to 2.x](#upgrading-to-rniftyreg-2x) is included at the end of this file.

Expand Down

0 comments on commit e9b8e18

Please sign in to comment.