This is the website dedicated to the development and the usage of the R package IsoriX.
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
Documentation
IsoriX
image
presentation
sources_for_future_functions
sources_for_vignettes
.gitignore
.travis.yml
IsoriX_project.Rproj
Makefile
README.md

README.md

Welcome to IsoriX

Build Status CRAN CRAN RStudio mirror downloads Rdoc codecov

This is the development repository of IsoriX, an R package aiming at building isoscapes using mixed models and inferring the geographic origin of organisms based on their isotopic ratios.

isoscape

How to download and install IsoriX?

You can download and install the stable version of IsoriX directly from within R by typing:

install.packages("IsoriX", dependencies = TRUE)

Note: if you get into troubles due to gmp, magick, maps, maptools, RandomFields, rgeos, or rgl, retry using simply:

install.packages("IsoriX")

These packages offer additional functionalities but some of them are particularly difficult to install on some systems.

If you want the development version of IsoriX, you can download and install it by typing:

devtools::install_github("courtiol/IsoriX/IsoriX")

Mind that the development version, being under development, can sometimes be broken. So before downloading it make sure that the current build status is build passing. The current built status is provided at the top of this readme document.

Also, if you access the network via a proxy, you may experience troubles with install_github. In such case try something like:

library(httr)
with_config(use_proxy("192.168.2.2:3128"), devtools::install_github("courtiol/IsoriX/IsoriX"))

Off course, unless you are in the same institute than some of us, replace the numbers with your proxy settings!

Where to learn about IsoriX?

You can start by reading our bookdown!

Then, if may not be a bad idea to also have a look at our papers: here and there.

For more specific help on IsoriX functions and objects, simply type:

help(package = "IsoriX")

in R after having installed and attached (= loaded) the package.

How can you contribute?

There are plenty way you can contribute! If you are fluent in R programming, you can improve the code and develop new functions. If you are not so fluent, you can still edit the documentation files to make them more complete and clearer, write new vignettes, report bugs or make feature requests.

Some useful links

  • about making R packages:

Simple introduction to the making of R packages

Writing R extensions

R coding standard

  • about the environment to develop IsoriX:

Using version control in RStudio

  • about other R packages on which IsoriX strongly depends:

spaMM

rasterVis