region_multiscan

Insert multiple named region tags into a sequence simultaneously, producing one variant per combination of non-overlapping tag positions. Use mode='sequential' to enumerate every valid arrangement deterministically; mode='random' samples one arrangement per draw.

import poolparty as pp
pp.init()

---

Parameters

Parameter	Type	Default	Description
pool	Pool | str	(required)	The Pool to scan. Can also be a plain sequence string.
tag_names	list[str] | str	(required)	Tag name(s) to insert. A single string is reused for every insertion; a list assigns one name per insertion.
num_insertions	int	(required)	Number of region tags to insert simultaneously.
positions	list | list[list] | None	None	Valid insertion positions (0-based, nontag-relative). A flat list or None shares positions across all insertions; a list-of-lists assigns per-insertion positions.
region	str | list | None	None	Restrict the scan to a named region (string) or a [start, stop] coordinate pair.
remove_tags	bool | None	None	When True and region is a region name, strip the constraint region tags from the output.
region_length	int | list[int]	0	Number of bases each scanning window spans. 0 = zero-length point tag. A single int applies to all insertions; a list assigns per-insertion lengths.
insertion_mode	str	'ordered'	'ordered' assigns tag_names left-to-right to positions; 'unordered' enumerates all valid tag-to-position assignments.
min_spacing	int | None	None	Minimum gap (in bases) between adjacent region tags.
max_spacing	int | None	None	Maximum gap (in bases) between adjacent region tags.
prefix	str | None	None	Prefix for the operation node name in the pool graph.
mode	str	'random'	'sequential' enumerates every valid arrangement as a separate state; 'random' samples one per draw.
num_states	int | None	None	Override the automatically-computed state count.
iter_order	float | None	None	Iteration priority for downstream multi-pool iteration.
cards	dict | list | None	None	Design card columns to include in library output.

---

Note

Only the most commonly used parameters are shown above. For the full parameter list, see region_multiscan() in the API Reference.

Examples

Two simultaneous point tags (region_length=0)

region_length=0 places two zero-length tags at every valid pair of positions in an 8-mer. With insertion_mode='ordered' (the default), a always appears to the left of b.

wt   = pp.from_seq("ATCGATCG")
scan = pp.region_multiscan(wt, tag_names=["a", "b"],
                           num_insertions=2, region_length=0,
                           mode="sequential")
scan.print_library()

scan: seq_length=8, num_states=36 <a/>A<b/>TCGATCG
<a/>AT<b/>CGATCG
<a/>ATC<b/>GATCG
<a/>ATCG<b/>ATCG
<a/>ATCGA<b/>TCG
... (36 total)

Spanning tags with minimum spacing (min_spacing)

min_spacing enforces a minimum gap between the end of one tagged region and the start of the next. Here two 2-base windows must be separated by at least 2 bases, reducing the state count from 15 to 6.

wt   = pp.from_seq("ATCGATCG")
scan = pp.region_multiscan(wt, tag_names=["a", "b"],
                           num_insertions=2, region_length=2,
                           min_spacing=2, mode="sequential")
scan.print_library()

scan: seq_length=8, num_states=6 <a>AT</a>CG<b>AT</b>CG
<a>AT</a>CGA<b>TC</b>G
<a>AT</a>CGAT<b>CG</b>
A<a>TC</a>GA<b>TC</b>G
A<a>TC</a>GAT<b>CG</b>
AT<a>CG</a>AT<b>CG</b>

Unordered insertion mode (insertion_mode)

By default (insertion_mode='ordered'), a is always placed to the left of b. Setting insertion_mode='unordered' allows either tag to appear at any position, doubling the state count (10 ordered vs 20 unordered on a 4-mer).

wt   = pp.from_seq("ATCG")
scan = pp.region_multiscan(wt, tag_names=["a", "b"],
                           num_insertions=2, region_length=0,
                           insertion_mode="unordered",
                           mode="sequential")
scan.print_library()

scan: seq_length=4, num_states=20 <a/>A<b/>TCG
<a/>AT<b/>CG
<a/>ATC<b/>G
<a/>ATCG<b/>
<b/>A<a/>TCG
A<a/>T<b/>CG
A<a/>TC<b/>G
A<a/>TCG<b/>
<b/>AT<a/>CG
A<b/>T<a/>CG
AT<a/>C<b/>G
AT<a/>CG<b/>
<b/>ATC<a/>G
A<b/>TC<a/>G
AT<b/>C<a/>G
ATC<a/>G<b/>
<b/>ATCG<a/>
A<b/>TCG<a/>
AT<b/>CG<a/>
ATC<b/>G<a/>

Multiscan within a named region

Restrict both tag insertions to within the cre region; flanking bases are never modified.

wt   = pp.from_seq("AAAA<cre>ATCGATCG</cre>TTTT")
scan = pp.region_multiscan(wt, tag_names=["a", "b"],
                           num_insertions=2, region_length=0,
                           region="cre", mode="sequential")
scan.print_library()

scan: seq_length=16, num_states=36 AAAA<cre><a/>A<b/>TCGATCG</cre>TTTT
AAAA<cre><a/>AT<b/>CGATCG</cre>TTTT
AAAA<cre><a/>ATC<b/>GATCG</cre>TTTT
AAAA<cre><a/>ATCG<b/>ATCG</cre>TTTT
AAAA<cre><a/>ATCGA<b/>TCG</cre>TTTT
... (36 total)

See region_multiscan().