Skip to content

Document X chromosome outputs #231

@gregorgorjanc

Description

@gregorgorjanc

Goal

X chromosome inputs are described in 36af2da (males 0,1 and females 0,1,2 genotypes and sex in pedigree (0 for males and 1 for females)), but we also need to document what the output mean - in particularly for the males.

Proposed approach

Document for each output file how to interpret the values.

Scope

docs/source/usage.rst - now that I have written this, I wonder if we should split that file into docs/source/usage.rst and docs/source/outputs.rst!?

Done when

When we have clear description of each output file for X chromosome.

Will be able to do it once PR #226 is merged in

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationtaskActionable tasks

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions