Reimplementation of TRIM for R
To install rtrim
, issue the following command at the R console.
install.packages("rtrim")
To get started, we recommend users to first work through the introductory vignette.This can be opened as follows.
library(rtrim)
vignette("rtrim_for_TRIM_users")
An extended introduction showing all options can be opened as follows:
library(rtrim)
vignette("Skylark_example")
After working through one of these vignettes, we advise users to have a look atthe help file of rtrim
's main function by typing ?trim
. Also, to get a feel of how the package works one can browse through the help files by following thelinks under the see also
sections in each help file.
Version 1.0.2 will be uploaded to CRAN on 31 march 2017.
See the NEWS file for a list of updates.
Sometimes we release a beta version for public testing.
Current Beta Version: 1.02
Beta versions can be installed as follows.
- If you are a Windows user, first install Rtools.
- Open an R session, and issue the following commands.
# we need the 'drat' package to install the review version:
if(!require(drat)) install.packages('drat')
# we tell R where to find the review version (on github)
drat::addRepo('markvanderloo')
# install as usual
install.packages('rtrim',type='source')
This procedure is necessary for the prerelease version. Once the package is on CRAN, installation of neither Rtools
nor drat
will be required.
The current package has been tested at two institutes and we have compared
numerical outcomes of hundreds of production jobs with outcomes of the original
TRIM software. We find that most results are reproducible to about 1E-4
or
better. Nevertheless, since this software has not been tried and tested for
over 25 years like TRIM has, you can still expect to bump into a rare bug or
difference.
We would really appreciate it if you let us know using the following instructions.
We'd love to hear your findings. It would be great if you could do this by adding
issues to our issues page. You will
need to create a github account for that. If you can not or do not want to create one,
send an e-mail to rtrim AT cbs dot nl
.
When reporting bugs, it helps us a lot if you can create an as small as possible example that demonstrates the error. Some good general guidelines for reporting bugs are given here