Metadata-Version: 1.1
Name: birdhousebuilder.recipe.r
Version: 0.1.3
Summary: A Buildout recipe to install R packages with Anaconda.
Home-page: http://www.dkrz.de
Author: Carsten Ehbrecht
Author-email: ehbrecht@dkrz.de
License: BSD
Description: *************************
        birdhousebuilder.recipe.r
        *************************
        
        .. contents::
        
        Introduction
        ************
        
        ``birdhousebuilder.recipe.r`` is a `Buildout`_ recipe to install `R Project`_ packages with `Anaconda`_.
        
        .. _`Buildout`: http://buildout.org/
        .. _`Anaconda`: http://continuum.io/
        .. _`R Project`: http://www.r-project.org/
        
        Usage
        *****
        
        The recipe requires that Anaconda is already installed. It assumes that Anaconda is installed at the default location in your home directory ``~/anaconda``. Otherwise you need to set the Buildout option ``anaconda-home`` to the correct location.
        
        It installs the ``r`` package from a conda channel with additional packages from a given ``R`` repository. ``R`` will then be available in Anaconda ``~/anaconda/bin/R``.
        
        The recipe depends on ``birdhousebuilder.recipe.conda``.
        
        Supported options
        =================
        
        The recipe supports the following options:
        
        ``anaconda-home``
           Buildout option with the root folder of the Anaconda installation. Default: ``$HOME/anaconda``.
        
        ``repo``
           `R Project`_ repository with ``R`` packages.
        
        ``pkgs``
           List of ``R`` packages which should be installed (space separated).
        
        
        Example usage
        =============
        
        Example usage in your ``buildout.cfg`` to install ``R`` with Anaconda and additional ``R`` packages (``sp``, ``raster``, ``ncdf``) from a ``R`` repository::
        
          [buildout]
          parts = r_pkgs
        
          anaconda-home = /home/myself/anaconda
        
          [r_pkgs]
          recipe = birdhousebuilder.recipe.r
          repo = http://ftp5.gwdg.de/pub/misc/cran
          pkgs = sp raster ncdf
        
        
        Authors
        *******
        
        Carsten Ehbrecht ehbrecht at dkrz.de
        
        Changes
        *******
        
        0.1.3 (2014-08-01)
        ==================
        
        Updated documention.
        
        0.1.2 (2014-07-30)
        ==================
        
        Bugfix: use R from anaconda home.
        
        0.1.1 (2014-07-21)
        ==================
        
        Bugfix: conda install of R package fails on CentOS
        
        0.1.0 (2014-07-10)
        ==================
        
        Initial Release.
        
Keywords: buildout recipe
Platform: UNKNOWN
Classifier: Framework :: Buildout
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Build Tools
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: License :: OSI Approved :: BSD License
