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

.. title:: Package Recipe 'bioconductor-cytomds'
.. highlight: bash

bioconductor-cytomds
====================

.. conda:recipe:: bioconductor-cytomds
   :replaces_section_title:
   :noindex:

   Low Dimensions projection of cytometry samples

   :homepage: https://bioconductor.org/packages/3.20/bioc/html/CytoMDS.html
   :license: GPL-3
   :recipe: /`bioconductor-cytomds <https://github.com/bioconda/bioconda-recipes/tree/master/recipes/bioconductor-cytomds>`_/`meta.yaml <https://github.com/bioconda/bioconda-recipes/tree/master/recipes/bioconductor-cytomds/meta.yaml>`_

   This package implements a low dimensional visualization of a set of cytometry samples\, in order to visually assess the \'distances\' between them. This\, in turn\, can greatly help the user to identify quality issues like batch effects or outlier samples\, and\/or check the presence of potential sample clusters that might align with the exeprimental design. The CytoMDS algorithm combines\, on the one hand\, the concept of Earth Mover\'s Distance \(EMD\)\, a.k.a. Wasserstein metric and\, on the other hand\, the Multi Dimensional Scaling \(MDS\) algorithm for the low dimensional projection. Also\, the package provides some diagnostic tools for both checking the quality of the MDS projection\, as well as tools to help with the interpretation of the axes of the projection.


.. conda:package:: bioconductor-cytomds

   |downloads_bioconductor-cytomds| |docker_bioconductor-cytomds|

   :versions:
      
      

      ``1.6.1-0``,  ``1.2.0-0``

      

   
   :depends on bioconductor-biobase: ``>=2.70.0,<2.71.0``
   :depends on bioconductor-biocparallel: ``>=1.44.0,<1.45.0``
   :depends on bioconductor-cytopipeline: ``>=1.10.0,<1.11.0``
   :depends on bioconductor-flowcore: ``>=2.22.0,<2.23.0``
   :depends on r-base: ``>=4.5,<4.6.0a0``
   :depends on r-ggforce: 
   :depends on r-ggplot2: 
   :depends on r-ggrepel: 
   :depends on r-patchwork: 
   :depends on r-pracma: 
   :depends on r-reshape2: 
   :depends on r-rlang: 
   :depends on r-smacof: 
   :depends on r-transport: 
   :depends on r-withr: 

   :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 bioconductor-cytomds

to add into an existing workspace instead, run::

    pixi add bioconductor-cytomds

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 bioconductor-cytomds

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

    conda create -n envname bioconductor-cytomds

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/bioconductor-cytomds:<tag>

(see `bioconductor-cytomds/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_bioconductor-cytomds| image:: https://img.shields.io/conda/dn/bioconda/bioconductor-cytomds.svg?style=flat
   :target: https://anaconda.org/bioconda/bioconductor-cytomds
   :alt:   (downloads)
.. |docker_bioconductor-cytomds| image:: https://quay.io/repository/biocontainers/bioconductor-cytomds/status
   :target: https://quay.io/repository/biocontainers/bioconductor-cytomds
.. _`bioconductor-cytomds/tags`: https://quay.io/repository/biocontainers/bioconductor-cytomds?tab=tags


.. raw:: html

    <script>
        var package = "bioconductor-cytomds";
        var versions = ["1.6.1","1.2.0"];
    </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/bioconductor-cytomds/README.html)

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