Skip to content

Commit

Permalink
Add documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
molpopgen committed Oct 28, 2020
1 parent 78fbdd7 commit 0a5a039
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 0 deletions.
2 changes: 2 additions & 0 deletions doc/pages/regiontypes.rst
Expand Up @@ -23,6 +23,8 @@ Setting up genomic intervals

.. automethod:: mv

.. autoclass:: fwdpy11.DiscreteDESD

.. autoclass:: fwdpy11.mvDES

.. autoclass:: fwdpy11.GeneticMapUnit
Expand Down
30 changes: 30 additions & 0 deletions fwdpy11/regions.py
Expand Up @@ -692,6 +692,36 @@ def __attrs_post_init__(self):
@attr_class_to_from_dict_no_recurse
@attr.s(eq=False, **_common_attr_attribs)
class DiscreteDESD(fwdpy11._fwdpy11._ll_DiscreteDESD):
"""
Discretized distribution of effect sizes and dominance.
This class allows you to specify a discrete joint
distrubtion of effect size and dominance.
The distribution is specified by a list of tuples.
Each tuple contains (effect size, dominance, weight).
The weights must all be >= 0 and all values must fe finite.
This class has the following attributes, whose names
are also ``kwargs`` for intitialization. The attribute names
also determine the order of positional arguments:
:param beg: Beginning of the region
:type beg: float
:param end: End of the region
:type end: float
:param weight: Weight on the region
:type weight: float
:param joint_dist: The joint distribution + weights
:type joint_dist: list
:param coupled: Specify if weight is function of end-beg or not. Defaults to True
:type coupled: bool
:param label: Fill :attr:`fwdpy11.Mutation.label` with this value.
:type label: numpy.uint16
.. versionadded:: 0.10.0
"""

beg: float
end: float
weight: float
Expand Down

0 comments on commit 0a5a039

Please sign in to comment.