The TradingAnalytics facade

RoundlyConsulting\TradingAnalytics\Facades\TradingAnalytics is the recommended entry point. Its root is RoundlyConsulting\TradingAnalytics\TradingAnalyticsManager, a container singleton that normalises the input and builds the Analytics engine. Every method takes a trade source: any iterable of trades or rows (anything Trade::fromRow() reads, Trade objects included, or a mix), or an ordered query — a query builder, an Eloquent builder or a relation. Rows are mapped lazily:

use RoundlyConsulting\TradingAnalytics\Facades\TradingAnalytics;

$analytics = TradingAnalytics::for($rows)->scale(2)->calculate(); // the engine, ready to configure
$analytics = TradingAnalytics::calculate($rows, only: [Counts::class]); // build and run in one call

// A query is a trade source too — streamed in pages of $chunk rows (default 1000)
$analytics = TradingAnalytics::calculate($account->trades()->orderBy('close_time')->orderBy('id'), chunk: 500);

$trades = TradingAnalytics::trades($rows);   // LazyCollection<int, Trade>, mapped lazily
TradingAnalytics::metrics();                 // the calculator class-strings only / except() accept

TradingAnalytics::using(DeskAnalytics::class); // build every engine from your subclass (once, in boot())
TradingAnalytics::engine();                    // 'App\Analytics\DeskAnalytics'

Every method

$trades is an iterable, a query builder, an Eloquent builder or a relation; $chunk is the page size when it is a query. for() and calculate() return the Analytics engine, so everything in Running the engine — scale(), usingWinRatePeriod(), only() / except(), the hooks — chains on. The facade class has no global alias; import it where you use it.

There is no TradingAnalytics::fake(): the engine is a pure calculation with no side effects, so a test feeds it the trades it needs and asserts on the numbers (see Testing).