:orphan:  .. only available via index, not via toctree

.. title:: Package Recipe 'r-ukbrapr'
.. highlight: bash

r-ukbrapr
=========

.. conda:recipe:: r-ukbrapr
   :replaces_section_title:
   :noindex:

   R functions to use in the UK Biobank Research Analysis Platform \(RAP\)

   :homepage: https://lcpilling.github.io/ukbrapR
   :developer docs: https://github.com/lcpilling/ukbrapR
   :license: GPL-3.0-only
   :recipe: /`r-ukbrapr <https://github.com/bioconda/bioconda-recipes/tree/master/recipes/r-ukbrapr>`_/`meta.yaml <https://github.com/bioconda/bioconda-recipes/tree/master/recipes/r-ukbrapr/meta.yaml>`_

   R functions to use in the UK Biobank Research Analysis Platform \(RAP\). The aim is to make working in the RAP quicker\, easier\, and more reproducible. Though some functions require a Spark cluster\, the package is mostly aimed to work in a \"normal\" cluster using RStudio\, and raw UK Biobank data from the table\-exporter.


.. conda:package:: r-ukbrapr

   |downloads_r-ukbrapr| |docker_r-ukbrapr|

   :versions:
      
      
      .. raw:: html

         <details><summary><span class="truncated-version-list"><code>0.3.14-0</code>,  <code>0.3.13-0</code>,  <code>0.3.12-0</code>,  <code>0.3.11-0</code>,  <code>0.3.10-0</code>,  <code>0.3.9-0</code>,  <code>0.3.8-0</code>,  <code>0.3.7-0</code>,  <code>0.3.6-0</code>,  </span></summary>
      

      ``0.3.14-0``,  ``0.3.13-0``,  ``0.3.12-0``,  ``0.3.11-0``,  ``0.3.10-0``,  ``0.3.9-0``,  ``0.3.8-0``,  ``0.3.7-0``,  ``0.3.6-0``,  ``0.3.5-0``,  ``0.3.4-0``,  ``0.3.3-0``,  ``0.3.2-0``,  ``0.3.1-0``,  ``0.3.0-1``,  ``0.3.0-0``,  ``0.2.9-0``

      
      .. raw:: html

         </details>
      

   
   :depends on r-base: ``>=4.5,<4.6.0a0``
   :depends on r-cli: ``>=3.6.1``
   :depends on r-dplyr: ``>=1.1.0``
   :depends on r-haven: ``>=2.5.0``
   :depends on r-lifecycle: ``>=1.0.0``
   :depends on r-lubridate: ``>=1.9.0``
   :depends on r-prettyunits: ``>=1.0.0``
   :depends on r-purrr: ``>=1.0.0``
   :depends on r-readr: ``>=2.0.0``
   :depends on r-rlang: ``>=1.0.0``
   :depends on r-stringr: ``>=1.5.0``
   :depends on r-tidyr: ``>=1.3.0``

   :additional platforms:
      

Installation
------------

You need a conda-compatible package manager
(currently either `pixi <https://pixi.sh>`__, `conda <https://docs.conda.io/projects/conda>`__, or `micromamba <https://mamba.readthedocs.io>`__)
and the Bioconda channel already activated (see :ref:`bioconda_setup`).
Below, we show how to install with either pixi or conda (for micromamba and mamba, commands are essentially the same as with conda).

Pixi
""""

With pixi_ installed and the Bioconda channel set up (see :ref:`bioconda_setup`),
to install globally, run::

    pixi global install r-ukbrapr

to add into an existing workspace instead, run::

    pixi add r-ukbrapr

In the latter case, make sure to first add bioconda and conda-forge to the channels considered by the workspace::

    pixi workspace channel add conda-forge
    pixi workspace channel add bioconda

Conda
"""""

With conda_ installed and the Bioconda channel set up (see :ref:`bioconda_setup`), to install into an existing and activated environment, run::

    conda install r-ukbrapr

Alternatively, to install into a new environment, run::

    conda create -n envname r-ukbrapr

with ``envname`` being the name of the desired environment.

Container
"""""""""

Alternatively, every Bioconda package is available as a container image for usage with your preferred container runtime.
For e.g. docker, run::

    docker pull quay.io/biocontainers/r-ukbrapr:<tag>

(see `r-ukbrapr/tags`_ for valid values for ``<tag>``).

Integrated deployment
"""""""""""""""""""""

Finally, note that many scientific workflow management systems directly integrate both conda and container based software deployment.
Thus, workflow steps can be often directly annotated to use the package, leading to automatic deployment by the respective workflow management system, thereby improving reproducibility and transparency.
Check the documentation of your workflow management system to find out about the integration.

.. _conda: https://conda.io
.. _pixi: https://pixi.sh
.. |downloads_r-ukbrapr| image:: https://img.shields.io/conda/dn/bioconda/r-ukbrapr.svg?style=flat
   :target: https://anaconda.org/bioconda/r-ukbrapr
   :alt:   (downloads)
.. |docker_r-ukbrapr| image:: https://quay.io/repository/biocontainers/r-ukbrapr/status
   :target: https://quay.io/repository/biocontainers/r-ukbrapr
.. _`r-ukbrapr/tags`: https://quay.io/repository/biocontainers/r-ukbrapr?tab=tags


.. raw:: html

    <script>
        var package = "r-ukbrapr";
        var versions = ["0.3.14","0.3.13","0.3.12","0.3.11","0.3.10"];
    </script>






Download stats
-----------------

.. raw:: html
    :file: ../../templates/package_dashboard.html

Link to this page
-----------------

Render an |install-with-bioconda| badge with the following MarkDown::

   [![install with bioconda](https://img.shields.io/badge/install%20with-bioconda-brightgreen.svg?style=flat)](http://bioconda.github.io/recipes/r-ukbrapr/README.html)

.. |install-with-bioconda| image:: https://img.shields.io/badge/install%20with-bioconda-brightgreen.svg?style=flat
   :target: http://bioconda.github.io/recipes/r-ukbrapr/README.html