kingchenc
7e5d394f2a
Clears the R CMD check **WARNING**s r-universe surfaced when it finally built 0.9.5 (it was stuck on 0.9.2, before the data layer existed): 11/13 platform builds reported the same two warnings. ### Warnings fixed 1. **Undocumented code objects** — the data layer added in 0.9.3 (`BinanceFeed`, `CandleReader`, `Resampler`, `TickAggregator`, `fetch_binance_klines` and the generics `name` / `is_ready` / `warmup_period` / `push` / `read`). The roxygen blocks existed in `methods.R`, but the `man/*.Rd` were never regenerated, and the constructors had only a title. 2. **Codoc mismatch** — `AwesomeOscillatorHistogram.Rd` still documented `sma_period` after the argument was renamed to `lookback`. ### Changes - Full `@param`/`@return` roxygen on the seven data-layer constructors. - Regenerated `man/*.Rd` + `NAMESPACE` with roxygen2: 13 new pages, the stale AwesomeOscillator usage refreshed, and `flush` registered on `base::flush`. - Fixed the `push()` example (`TickAggregator(1000)` was missing the required `gap_fill`) — it only ran once `push()` got a generated `.Rd`. - **New CI gate:** a ubuntu-only `R CMD check` in the `r` job that fails on doc WARNING/ERROR, so stale docs fail the PR instead of reaching r-universe. Verified locally with `R CMD check` (R 4.6.0 + Rtools45): *missing documentation entries* and *Rd \usage sections* now **OK**, examples **OK**, tests **OK**. This PR's own CI exercises the new gate. Follow-up: a separate `0.9.6` release ships these doc fixes to r-universe.
541 lines
11 KiB
Plaintext
541 lines
11 KiB
Plaintext
# Generated by roxygen2: do not edit by hand
|
|
|
|
S3method(base::flush,wickra_indicator)
|
|
S3method(batch,wickra_indicator)
|
|
S3method(is_ready,wickra_indicator)
|
|
S3method(name,wickra_indicator)
|
|
S3method(push,wickra_indicator)
|
|
S3method(read,wickra_indicator)
|
|
S3method(reset,wickra_indicator)
|
|
S3method(update,wickra_indicator)
|
|
S3method(warmup_period,wickra_indicator)
|
|
export(AbandonedBaby)
|
|
export(Abcd)
|
|
export(AbsoluteBreadthIndex)
|
|
export(AccelerationBands)
|
|
export(AcceleratorOscillator)
|
|
export(AdOscillator)
|
|
export(AdVolumeLine)
|
|
export(AdaptiveCci)
|
|
export(AdaptiveCycle)
|
|
export(AdaptiveLaguerreFilter)
|
|
export(AdaptiveRsi)
|
|
export(Adl)
|
|
export(AdvanceBlock)
|
|
export(AdvanceDecline)
|
|
export(AdvanceDeclineRatio)
|
|
export(Adx)
|
|
export(Adxr)
|
|
export(Alligator)
|
|
export(Alma)
|
|
export(Alpha)
|
|
export(AmihudIlliquidity)
|
|
export(AnchoredRsi)
|
|
export(AnchoredVwap)
|
|
export(AndrewsPitchfork)
|
|
export(Apo)
|
|
export(Aroon)
|
|
export(AroonOscillator)
|
|
export(Atr)
|
|
export(AtrBands)
|
|
export(AtrRatchet)
|
|
export(AtrTrailingStop)
|
|
export(AutoFib)
|
|
export(Autocorrelation)
|
|
export(AutocorrelationPeriodogram)
|
|
export(AverageDailyRange)
|
|
export(AverageDrawdown)
|
|
export(AvgPrice)
|
|
export(AwesomeOscillator)
|
|
export(AwesomeOscillatorHistogram)
|
|
export(BalanceOfPower)
|
|
export(BandpassFilter)
|
|
export(Bat)
|
|
export(BeltHold)
|
|
export(Beta)
|
|
export(BetaNeutralSpread)
|
|
export(BetterVolume)
|
|
export(BinanceFeed)
|
|
export(BipowerVariation)
|
|
export(BodySizePct)
|
|
export(BollingerBands)
|
|
export(BollingerBandwidth)
|
|
export(BomarBands)
|
|
export(BreadthThrust)
|
|
export(Breakaway)
|
|
export(BullishPercentIndex)
|
|
export(BurkeRatio)
|
|
export(Butterfly)
|
|
export(CalendarSpread)
|
|
export(CalmarRatio)
|
|
export(Camarilla)
|
|
export(CandleReader)
|
|
export(CandleVolume)
|
|
export(Cci)
|
|
export(CenterOfGravity)
|
|
export(CentralPivotRange)
|
|
export(Cfo)
|
|
export(ChaikinMoneyFlow)
|
|
export(ChaikinOscillator)
|
|
export(ChaikinVolatility)
|
|
export(ChandeKrollStop)
|
|
export(ChandelierExit)
|
|
export(ChoppinessIndex)
|
|
export(ClassicPivots)
|
|
export(CloseVsOpen)
|
|
export(ClosingMarubozu)
|
|
export(Cmo)
|
|
export(CoefficientOfVariation)
|
|
export(Cointegration)
|
|
export(CommonSenseRatio)
|
|
export(CompositeProfile)
|
|
export(ConcealingBabySwallow)
|
|
export(ConditionalValueAtRisk)
|
|
export(ConnorsRsi)
|
|
export(Coppock)
|
|
export(CorrelationTrendIndicator)
|
|
export(Counterattack)
|
|
export(Crab)
|
|
export(CumulativeVolumeDelta)
|
|
export(CumulativeVolumeIndex)
|
|
export(CupAndHandle)
|
|
export(CyberneticCycle)
|
|
export(Cypher)
|
|
export(DayOfWeekProfile)
|
|
export(Decycler)
|
|
export(DecyclerOscillator)
|
|
export(Dema)
|
|
export(DemandIndex)
|
|
export(DemarkPivots)
|
|
export(DepthSlope)
|
|
export(DerivativeOscillator)
|
|
export(DetrendedStdDev)
|
|
export(DisparityIndex)
|
|
export(DistanceSsd)
|
|
export(Doji)
|
|
export(DojiStar)
|
|
export(DollarBars)
|
|
export(Donchian)
|
|
export(DonchianStop)
|
|
export(DoubleBollinger)
|
|
export(DoubleTopBottom)
|
|
export(DownsideGapThreeMethods)
|
|
export(Dpo)
|
|
export(DragonflyDoji)
|
|
export(DrawdownDuration)
|
|
export(DumplingTop)
|
|
export(Dx)
|
|
export(DynamicMomentumIndex)
|
|
export(EaseOfMovement)
|
|
export(EffectiveSpread)
|
|
export(EhlersStochastic)
|
|
export(Ehma)
|
|
export(ElderImpulse)
|
|
export(ElderRay)
|
|
export(ElderSafeZone)
|
|
export(Ema)
|
|
export(EmpiricalModeDecomposition)
|
|
export(Engulfing)
|
|
export(Equivolume)
|
|
export(EstimatedLeverageRatio)
|
|
export(EvenBetterSinewave)
|
|
export(EveningDojiStar)
|
|
export(Evwma)
|
|
export(EwmaVolatility)
|
|
export(Expectancy)
|
|
export(FallingThreeMethods)
|
|
export(Fama)
|
|
export(FibArcs)
|
|
export(FibChannel)
|
|
export(FibConfluence)
|
|
export(FibExtension)
|
|
export(FibFan)
|
|
export(FibProjection)
|
|
export(FibRetracement)
|
|
export(FibTimeZones)
|
|
export(FibonacciPivots)
|
|
export(FisherRsi)
|
|
export(FisherTransform)
|
|
export(FlagPennant)
|
|
export(Footprint)
|
|
export(ForceIndex)
|
|
export(FractalChaosBands)
|
|
export(Frama)
|
|
export(FryPanBottom)
|
|
export(FundingBasis)
|
|
export(FundingImpliedApr)
|
|
export(FundingRate)
|
|
export(FundingRateMean)
|
|
export(FundingRateZScore)
|
|
export(GainLossRatio)
|
|
export(GainToPainRatio)
|
|
export(GapSideBySideWhite)
|
|
export(Garch11)
|
|
export(GarmanKlassVolatility)
|
|
export(Gartley)
|
|
export(GatorOscillator)
|
|
export(GeneralizedDema)
|
|
export(GeometricMa)
|
|
export(GoldenPocket)
|
|
export(GrangerCausality)
|
|
export(GravestoneDoji)
|
|
export(Hammer)
|
|
export(HangingMan)
|
|
export(Harami)
|
|
export(HaramiCross)
|
|
export(HasbrouckInformationShare)
|
|
export(HeadAndShoulders)
|
|
export(HeikinAshi)
|
|
export(HeikinAshiOscillator)
|
|
export(HiLoActivator)
|
|
export(HighLowIndex)
|
|
export(HighLowRange)
|
|
export(HighLowVolumeNodes)
|
|
export(HighWave)
|
|
export(HighpassFilter)
|
|
export(Hikkake)
|
|
export(HikkakeModified)
|
|
export(HilbertDominantCycle)
|
|
export(HistoricalVolatility)
|
|
export(Hma)
|
|
export(HoltWinters)
|
|
export(HomingPigeon)
|
|
export(HtDcPhase)
|
|
export(HtPhasor)
|
|
export(HtTrendMode)
|
|
export(HurstChannel)
|
|
export(HurstExponent)
|
|
export(Ichimoku)
|
|
export(IdenticalThreeCrows)
|
|
export(ImbalanceBars)
|
|
export(InNeck)
|
|
export(Inertia)
|
|
export(InformationRatio)
|
|
export(InitialBalance)
|
|
export(InstantaneousTrendline)
|
|
export(IntradayIntensity)
|
|
export(IntradayMomentumIndex)
|
|
export(IntradayVolatilityProfile)
|
|
export(InverseFisherTransform)
|
|
export(InvertedHammer)
|
|
export(JarqueBera)
|
|
export(Jma)
|
|
export(JumpIndicator)
|
|
export(KRatio)
|
|
export(KagiBars)
|
|
export(KalmanHedgeRatio)
|
|
export(Kama)
|
|
export(KaseDevStop)
|
|
export(KasePermissionStochastic)
|
|
export(KellyCriterion)
|
|
export(Keltner)
|
|
export(KendallTau)
|
|
export(Kicking)
|
|
export(KickingByLength)
|
|
export(Kst)
|
|
export(Kurtosis)
|
|
export(Kvo)
|
|
export(KylesLambda)
|
|
export(LadderBottom)
|
|
export(LaguerreRsi)
|
|
export(LeadLagCrossCorrelation)
|
|
export(LinRegAngle)
|
|
export(LinRegChannel)
|
|
export(LinRegIntercept)
|
|
export(LinRegSlope)
|
|
export(LinearRegression)
|
|
export(LiquidationFeatures)
|
|
export(LogReturn)
|
|
export(LongLeggedDoji)
|
|
export(LongLine)
|
|
export(LongShortRatio)
|
|
export(M2Measure)
|
|
export(MaEnvelope)
|
|
export(MacdExt)
|
|
export(MacdFix)
|
|
export(MacdHistogram)
|
|
export(MacdIndicator)
|
|
export(Mama)
|
|
export(MarketFacilitationIndex)
|
|
export(MartinRatio)
|
|
export(Marubozu)
|
|
export(MassIndex)
|
|
export(MatHold)
|
|
export(MatchingLow)
|
|
export(MaxDrawdown)
|
|
export(McClellanOscillator)
|
|
export(McClellanSummationIndex)
|
|
export(McGinleyDynamic)
|
|
export(MedianAbsoluteDeviation)
|
|
export(MedianChannel)
|
|
export(MedianMa)
|
|
export(MedianPrice)
|
|
export(Mfi)
|
|
export(Microprice)
|
|
export(MidPoint)
|
|
export(MidPrice)
|
|
export(MinusDi)
|
|
export(MinusDm)
|
|
export(ModifiedMaStop)
|
|
export(Mom)
|
|
export(MorningDojiStar)
|
|
export(MorningEveningStar)
|
|
export(MurreyMathLines)
|
|
export(NakedPoc)
|
|
export(Natr)
|
|
export(NewHighsNewLows)
|
|
export(NewPriceLines)
|
|
export(Nrtr)
|
|
export(Nvi)
|
|
export(OIPriceDivergence)
|
|
export(OIWeighted)
|
|
export(Obv)
|
|
export(OiToVolumeRatio)
|
|
export(OmegaRatio)
|
|
export(OnNeck)
|
|
export(OpenInterestDelta)
|
|
export(OpenInterestMomentum)
|
|
export(OpeningMarubozu)
|
|
export(OpeningRange)
|
|
export(OrderBookImbalanceFull)
|
|
export(OrderBookImbalanceTop1)
|
|
export(OrderBookImbalanceTopN)
|
|
export(OrderFlowImbalance)
|
|
export(OuHalfLife)
|
|
export(OvernightGap)
|
|
export(OvernightIntradayReturn)
|
|
export(PainIndex)
|
|
export(PairSpreadZScore)
|
|
export(PairwiseBeta)
|
|
export(ParkinsonVolatility)
|
|
export(PearsonCorrelation)
|
|
export(PercentAboveMa)
|
|
export(PercentB)
|
|
export(PercentageTrailingStop)
|
|
export(PerpetualPremiumIndex)
|
|
export(Pgo)
|
|
export(PiercingDarkCloud)
|
|
export(Pin)
|
|
export(PivotReversal)
|
|
export(PlusDi)
|
|
export(PlusDm)
|
|
export(Pmo)
|
|
export(PointAndFigureBars)
|
|
export(PolarizedFractalEfficiency)
|
|
export(Ppo)
|
|
export(PpoHistogram)
|
|
export(ProfileShape)
|
|
export(ProfitFactor)
|
|
export(ProjectionBands)
|
|
export(ProjectionOscillator)
|
|
export(Psar)
|
|
export(Pvi)
|
|
export(Qqe)
|
|
export(Qstick)
|
|
export(QuartileBands)
|
|
export(QuotedSpread)
|
|
export(RSquared)
|
|
export(RangeBars)
|
|
export(RealizedSpread)
|
|
export(RealizedVolatility)
|
|
export(RecoveryFactor)
|
|
export(RectangleRange)
|
|
export(Reflex)
|
|
export(RegimeLabel)
|
|
export(RelativeStrengthAB)
|
|
export(RenkoBars)
|
|
export(RenkoTrailingStop)
|
|
export(Resampler)
|
|
export(RickshawMan)
|
|
export(RisingThreeMethods)
|
|
export(Rmi)
|
|
export(Roc)
|
|
export(Rocp)
|
|
export(Rocr)
|
|
export(Rocr100)
|
|
export(RogersSatchellVolatility)
|
|
export(RollMeasure)
|
|
export(RollingCorrelation)
|
|
export(RollingCovariance)
|
|
export(RollingIqr)
|
|
export(RollingMinMaxScaler)
|
|
export(RollingPercentileRank)
|
|
export(RollingQuantile)
|
|
export(RollingVwap)
|
|
export(RoofingFilter)
|
|
export(Rsi)
|
|
export(Rsx)
|
|
export(RunBars)
|
|
export(Rvi)
|
|
export(RviVolatility)
|
|
export(Rwi)
|
|
export(SampleEntropy)
|
|
export(SarExt)
|
|
export(SeasonalZScore)
|
|
export(SeparatingLines)
|
|
export(SessionHighLow)
|
|
export(SessionRange)
|
|
export(SessionVwap)
|
|
export(ShannonEntropy)
|
|
export(Shark)
|
|
export(SharpeRatio)
|
|
export(ShootingStar)
|
|
export(ShortLine)
|
|
export(SignedVolume)
|
|
export(SineWave)
|
|
export(SineWeightedMa)
|
|
export(SinglePrints)
|
|
export(Skewness)
|
|
export(Sma)
|
|
export(Smi)
|
|
export(Smma)
|
|
export(SmoothedHeikinAshi)
|
|
export(SortinoRatio)
|
|
export(SpearmanCorrelation)
|
|
export(SpinningTop)
|
|
export(SpreadAr1Coefficient)
|
|
export(SpreadBollingerBands)
|
|
export(SpreadHurst)
|
|
export(StalledPattern)
|
|
export(StandardError)
|
|
export(StandardErrorBands)
|
|
export(StarcBands)
|
|
export(Stc)
|
|
export(StdDev)
|
|
export(StepTrailingStop)
|
|
export(SterlingRatio)
|
|
export(StickSandwich)
|
|
export(StochRsi)
|
|
export(Stochastic)
|
|
export(StochasticCci)
|
|
export(SuperSmoother)
|
|
export(SuperTrend)
|
|
export(T3)
|
|
export(TailRatio)
|
|
export(TakerBuySellRatio)
|
|
export(Takuri)
|
|
export(TasukiGap)
|
|
export(TdCamouflage)
|
|
export(TdClop)
|
|
export(TdClopwin)
|
|
export(TdCombo)
|
|
export(TdCountdown)
|
|
export(TdDWave)
|
|
export(TdDeMarker)
|
|
export(TdDifferential)
|
|
export(TdLines)
|
|
export(TdMovingAverage)
|
|
export(TdOpen)
|
|
export(TdPressure)
|
|
export(TdPropulsion)
|
|
export(TdRangeProjection)
|
|
export(TdRei)
|
|
export(TdRiskLevel)
|
|
export(TdSequential)
|
|
export(TdSetup)
|
|
export(TdTrap)
|
|
export(Tema)
|
|
export(TermStructureBasis)
|
|
export(ThreeDrives)
|
|
export(ThreeInside)
|
|
export(ThreeLineBreak)
|
|
export(ThreeLineBreakBars)
|
|
export(ThreeLineStrike)
|
|
export(ThreeOutside)
|
|
export(ThreeSoldiersOrCrows)
|
|
export(ThreeStarsInSouth)
|
|
export(Thrusting)
|
|
export(TickAggregator)
|
|
export(TickBars)
|
|
export(TickIndex)
|
|
export(Tii)
|
|
export(TimeBasedStop)
|
|
export(TimeOfDayReturnProfile)
|
|
export(TowerTopBottom)
|
|
export(TpoProfile)
|
|
export(TradeImbalance)
|
|
export(TradeSignAutocorrelation)
|
|
export(TradeVolumeIndex)
|
|
export(TrendLabel)
|
|
export(TrendStrengthIndex)
|
|
export(Trendflex)
|
|
export(TreynorRatio)
|
|
export(Triangle)
|
|
export(Trima)
|
|
export(Trin)
|
|
export(TripleTopBottom)
|
|
export(Tristar)
|
|
export(Trix)
|
|
export(TrueRange)
|
|
export(Tsf)
|
|
export(TsfOscillator)
|
|
export(Tsi)
|
|
export(Tsv)
|
|
export(TtmSqueeze)
|
|
export(TtmTrend)
|
|
export(TurnOfMonth)
|
|
export(Tweezer)
|
|
export(TwiggsMoneyFlow)
|
|
export(TwoCrows)
|
|
export(TypicalPrice)
|
|
export(UlcerIndex)
|
|
export(UltimateOscillator)
|
|
export(UniqueThreeRiver)
|
|
export(UniversalOscillator)
|
|
export(UpDownVolumeRatio)
|
|
export(UpsideGapThreeMethods)
|
|
export(UpsideGapTwoCrows)
|
|
export(UpsidePotentialRatio)
|
|
export(ValueArea)
|
|
export(ValueAtRisk)
|
|
export(Variance)
|
|
export(VarianceRatio)
|
|
export(VerticalHorizontalFilter)
|
|
export(Vidya)
|
|
export(VolatilityCone)
|
|
export(VolatilityOfVolatility)
|
|
export(VolatilityRatio)
|
|
export(VoltyStop)
|
|
export(VolumeBars)
|
|
export(VolumeByTimeProfile)
|
|
export(VolumeOscillator)
|
|
export(VolumePriceTrend)
|
|
export(VolumeProfile)
|
|
export(VolumeRsi)
|
|
export(VolumeWeightedMacd)
|
|
export(VolumeWeightedSr)
|
|
export(Vortex)
|
|
export(Vpin)
|
|
export(Vwap)
|
|
export(VwapStdDevBands)
|
|
export(Vwma)
|
|
export(Vzo)
|
|
export(Wad)
|
|
export(WavePm)
|
|
export(WaveTrend)
|
|
export(Wedge)
|
|
export(WeightedClose)
|
|
export(WickRatio)
|
|
export(WilliamsFractals)
|
|
export(WilliamsR)
|
|
export(WinRate)
|
|
export(Wma)
|
|
export(WoodiePivots)
|
|
export(YangZhangVolatility)
|
|
export(YoyoExit)
|
|
export(ZScore)
|
|
export(ZeroLagMacd)
|
|
export(ZigZag)
|
|
export(Zlema)
|
|
export(batch)
|
|
export(binance_close)
|
|
export(binance_next)
|
|
export(fetch_binance_klines)
|
|
export(is_ready)
|
|
export(name)
|
|
export(push)
|
|
export(read)
|
|
export(reset)
|
|
export(warmup_period)
|
|
importFrom(stats,update)
|