Skip to content

Commit

Permalink
PSW-113: Minor documentation changes
Browse files Browse the repository at this point in the history
  • Loading branch information
miriambt committed Jan 10, 2025
1 parent 93ef039 commit ea90d72
Showing 1 changed file with 3 additions and 4 deletions.
7 changes: 3 additions & 4 deletions snputils/snp/genobj/snpobj.py
Original file line number Diff line number Diff line change
Expand Up @@ -1390,14 +1390,13 @@ def convert_to_window_level(
2. **Custom start and end positions**:
- Provide `physical_pos` (2D array of shape (n_windows, 2)) as the [start, end] base-pair
coordinates for each window.
- If `chromosomes` is not provided and the dataset has exactly one chromosome, it will be
assumed all windows are on that chromosome.
- If `chromosomes` is not provided and `self` has exactly one chromosome, all windows are
assumed to belong to that chromosome.
- If multiple chromosomes exist but `chromosomes` is missing, an error will be raised.
- Optionally, provide `window_sizes` to store the SNP count per-window.
3. **Matching existing windows**:
- Provide a `laiobj` from which to reuse window definitions
(physical_pos, chromosomes, window_sizes).
- Reuse window definitions (`physical_pos`, `chromosomes`, `window_sizes`) from an existing `laiobj`.
Args:
window_size (int, optional):
Expand Down

0 comments on commit ea90d72

Please sign in to comment.