discover_site_avoidance
Sweep a set of sequences against every exact recognition site in the NEB catalog and report the sites each one carries far less (avoided) or far more (enriched) often than a stated null predicts, with the false discovery rate controlled across every (sequence, site) test.
Tool call template
This tool declares no required parameters. Add optional parameters from the input schema as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {},
"name": "discover_site_avoidance"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| seed | No | seed for the shuffles, so a run reproduces. Only applies when null_model is shuffle. Advanced. | |
| alpha | No | false discovery rate at which a site is reported avoided or enriched. | |
| _files | No | The project: record references shaped like _subject. Their records become library documents a tool names in sequences/parts/document; a trace or alignment is found by file name. | |
| enzymes | No | restrict the sweep to these enzymes' sites (NEB names). Empty sweeps every exact site in the catalog; degenerate (IUPAC) sites are never swept and are listed in the result. Advanced. | |
| _subject | No | The record to act on: exactly one of sequence, accession (+source), sample (an id from list_samples) or file ({name, text} or {name, base64}); record_index picks one record of several. | |
| shuffles | No | shuffles per record. The smallest p the null can give is 1 / (shuffles + 1). Only applies when null_model is shuffle. | |
| positions | No | also return every occurrence's coordinate and strand, for drawing on a map. Advanced. | |
| sequences | No | the corpus: wire upstream records here, or list library document names. Each is one record of the sweep. | |
| shuffle_k | No | k-let size the shuffles preserve. 2 holds every dinucleotide count, so CpG depletion is in the null. Only applies when null_model is shuffle. | |
| correction | No | Benjamini–Hochberg (independent or positively dependent tests) or Benjamini–Yekutieli (any dependence, including overlapping sites on one sequence; less power). Values: BH (Benjamini–Hochberg), BY (Benjamini–Yekutieli). | BH |
| null_model | No | what a site is rare relative to: base composition, shuffles that keep the record's own k-let counts, or the record's own (k−1)-mers for a site of length k (R'MES maximal order, Gaussian score). Values: order0 (Base composition (order-0)), shuffle (k-let shuffles (uShuffle)), maximal (Maximal-order Markov (R'MES)). | order0 |
| include_subject | No | also sweep the node's subject (the open or wired record). | |
| min_site_length | No | shortest recognition site swept. In bp. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| sweep | Yes | the full result, including the records swept and the degenerate sites skipped | |
| tests | Yes | every (record, site) test: observed, expected, ratio, both tails and both q-values; under the maximal-order null also the R'MES score z and its variance | |
| avoided | Yes | tests whose low-tail q is at or below alpha, most extreme ratio first | |
| enriched | Yes | tests whose high-tail q is at or below alpha, most extreme ratio first | |
| nullModel | Yes | the null the p-values stand on, stated with every run | |
| correction | Yes | the multiple-testing correction that ran, and why it is valid | |
| avoidedCount | Yes | how many (record, site) tests were called avoided | |
| enrichedCount | Yes | how many (record, site) tests were called enriched |