as_weitrix {weitrix} | R Documentation

## Convert data to a weitrix

### Description

Ensure data is a weighted matrix or "weitrix". A weitrix is a SummarizedExperiment or subclass thereof with some metadata fields set. If it is ambiguous how to do this, produce an error.

### Usage

    as_weitrix(object, weights = NULL)

### Arguments

`object` | Object to convert.
`weights` | Optional, weights matrix if not present in `object`.

### Details

Input can be a matrix or DelayedArray.

Input can be anything the limma package recognizes, notably the limma EList class (for example as output by `voom` or `vooma`).

If weights are not present in "object" and not given with "weights", they default for 0 for NA values and 1 for everything else.

### Value

A SummarizedExperiment object with metadata fields marking it as a weitrix.

### Examples

    mat <- matrix(c(1,2,NA,3,NA,4), ncol=2)
    weitrix <- as_weitrix(mat)

    metadata(weitrix)
    weitrix_x(weitrix)
    weitrix_weights(weitrix)

[Package weitrix version 1.0.0 Index]