Skip to main content

Module research

Module research 

Source
Expand description

One module per domain, for code that wants to say which it means.

Modules§

record_view
Nested message and enum types in RecordView.

Structs§

Advice
AfterTaxView
The dividend bias, measured.
AttachRequest
A file to keep with a finding the caller already recorded or ran.
Attachment
One file kept with a finding: bytes stored once by content hash, listed on the record.
AttachmentRef
Attachments
BarView
One bar, as the chart wants it. One bar of the library, as the research tier reads it (#195).
BarsRequest
Bars, or the regimes read off them, over a window of the library (#195).
BarsView
BookRequest
BookView
What one account holding every member of a panel would have done.
BreadthView
How much of a panel’s apparent breadth is real.
CandlePoint
ComparisonRowView
One finding in a side-by-side comparison.
ComparisonView
Several findings, read against each other.
CorrelationRow
One row of a correlation matrix. A cell with no value is a pair with too little overlap to say anything about, which is not the same as zero.
CurvePoint
One point on a curve, in the shape a chart library wants: an ISO date and a value.
DivergenceView
Where a replay first stopped matching the record.
DividendGapView
Finding
One finding: the verdict and how far it may be read, before any number.
FindingId
FindingIds
FindingSummary
Findings
Fixed
FoldView
One fold of a walk-forward, flattened for display.
HistoryEntryView
HistoryView
What the workbench shows before anything has been run. Everything in research memory, and what could not be read of it.
InstrumentChartView
One instrument’s bars with its own trades marked on them.
LedgerTrade
One trade in a ledger: a round trip, or a position still open at the end (empty closed, no exit).
MemberView
What one member of a book actually contributed.
MetricsView
MonthlyReturnView
One month of the strategy’s return, for the heatmap.
NamedCurveView
A named equity curve, for drawing several on one chart.
NamedNumber
What a front end renders.
OptionalDouble
OutcomeView
One instrument’s out-of-sample outcome under the panel’s configuration.
PanelView
A panel study, flattened for display.
Param
A ruleset parameter: one value fixes it, several search it.
Point
One point of an equity curve. at is YYYY-MM-DDTHH:MM:SS or a date.
ProblemsView
The Problems panel’s rows.
RecommendationView
One thing to do about a finding, flattened for display.
RecordView
A stored finding, reopened.
RegimePointView
The regime each bar closed in: “trending up”, “trending down” or “ranging”, absent until the lookback has filled. Labelled after the fact over the closes, so it says what the market was doing and not what a rule could have known at the time.
RegimeView
ReplayView
What came back from re-running a stored finding.
ReportFigure
ReportRequest
Evidence an engine Arvo did not run computed (ADR-0026). What a run produces, before anyone concludes anything from it; Arvo computes the verdict. There is no field for a verdict, a metric or a p-value.
ReportedView
A finding an engine Arvo did not run computed, judged by Arvo (ADR-0026). Shown as what it is: the numbers and the verdict, and where the data lives.
ResearchProblemView
A finding’s caveat, against the script line that produced the finding: what the Problems panel lists with source “Arvo” (ADR-0021).
RiskModel
The project’s risk file (.arvo/risk.json), as read for the next study.
Rule
A rule this build implements, with the search it ships.
Rules
Ruleset
One file under <project>/rulesets/, as the picker sees it.
RulesetForm
A grid ruleset’s parts, for a form.
RulesetPath
Rulesets
RunRequest
SharedExperiment
StabilityView
How much one parameter moved across the folds.
Strategies
Strategy
StudyRequest
StudyView
The full result of a study, flattened for display.
SurfaceCell
One configuration’s cell on the search surface.
SurfaceView
The in-sample score of every configuration the search tried.
TradeExport
TradeMarkerView
Where a trade happened, to be drawn on the price.
TradeRow
One round trip, as a trades table shows it and a CSV export writes it.
TradeRowView
One round trip, as a table row.
TradesView
What the round trips looked like, flattened for display.
UnreadableView
A finding that could not be read, and why.
WalkForwardView
A walk-forward run, flattened for display.