File: loom_validator.rst

package info (click to toggle)
python-loompy 3.0.7%2Bdfsg-4
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 3,316 kB
  • sloc: python: 3,152; sh: 63; makefile: 16
file content (33 lines) | stat: -rw-r--r-- 1,268 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
LoomValidator (class)
=====================

Validate the content of a Loom file against the file format specification and/or attrubute conventions.

.. highlight:: python
.. code-block:: python

    >>> lv = loompy.LoomValidator()
    >>> if not lv.validate(d+f, strictness="conventions"):
    >>>     for warn in lv.warnings:
    >>>         print("WARNING:", warn)
    >>>     for err in lv.errors:
    >>>         print("ERROR:", err)

    WARNING: Optional global attribute 'Description' is missing
    WARNING: Optional global attribute 'Journal' is missing
    WARNING: Optional global attribute 'Authors' is missing
    WARNING: Optional global attribute 'Title' is missing
    WARNING: Optional global attribute 'Year' is missing
    WARNING: Optional column attribute 'ClusterName' is missing
    WARNING: Optional column attribute 'Valid' is missing
    WARNING: Optional row attribute 'Valid' is missing
    WARNING: Optional row attribute 'Selected' is missing
    ERROR: Column attribute 'ClusterID' is missing
    ERROR: Column attribute 'CellID' cannot contain duplicate values
    ERROR: For help, see http://linnarssonlab.org/loompy/conventions/


.. autoclass:: loompy.LoomValidator
    :special-members: __init__ 
    :members:
    :undoc-members: