Weighted Close indicator and its strategy are added.

[cinar]

Describe Request

Weighted Close indicator and its strategy are added.

Fixed #242

Change Type

New feature.

Summary by CodeRabbit

• New Features

  • Introduced the "Weighted Close" indicator and "Weighted Close Strategy" to enhance technical analysis tools.
  • Added a new trend strategy for calculating the weighted close of assets.
  • Implemented functionality for generating actionable recommendations and detailed reports based on asset snapshots.

• Bug Fixes

  • Minor formatting adjustments in documentation for improved clarity.

• Tests

  • Added comprehensive tests for both the "Weighted Close" indicator and "Weighted Close Strategy" to ensure functionality and accuracy.

[coderabbitai]

Note

Currently processing new changes in this PR. This may take a few minutes, please wait...

📥 Commits

Reviewing files that changed from the base of the PR and between ea8ed69 and cf59746.

📒 Files selected for processing (1)

• trend/weighted_close.go (1 hunks)

 ______________________________________________________________________________
< Dr. CodeRabbit, or: How I Learned to Stop Worrying and Love the Code Review. >
 ------------------------------------------------------------------------------
  \
   \   (\__/)
       (•ㅅ•)
       / 　 づ

Walkthrough

This pull request introduces the Weighted Close indicator and strategy to the technical analysis library. The implementation includes a new WeightedClose type in the trend package that calculates the weighted close price using the formula (High + Low + (Close * 2)) / 4. A corresponding WeightedCloseStrategy is added to provide trading recommendations based on the weighted close price relative to a moving average.

Changes

File	Change Summary
README.md	Added "Weighted Close" indicator and "Weighted Close Strategy" to supported indicators and strategies
strategy/trend/trend.go	Added NewWeightedCloseStrategy() to AllStrategies function
strategy/trend/weighted_close_strategy.go	New implementation of WeightedCloseStrategy with computation and reporting methods
trend/weighted_close.go	New implementation of WeightedClose indicator with computation methods
trend/weighted_close_test.go	Added test cases for WeightedClose indicator

Sequence Diagram

sequenceDiagram
    participant Snapshots as Asset Snapshots
    participant Strategy as WeightedCloseStrategy
    participant WeightedClose as Weighted Close Indicator
    participant MovingAverage as Moving Average
    
    Snapshots->>Strategy: Input snapshots
    Strategy->>WeightedClose: Compute weighted close
    Strategy->>MovingAverage: Calculate moving average
    Strategy->>Strategy: Compare weighted close with MA
    Strategy-->>Snapshots: Generate buy/sell actions

Loading

Assessment against linked issues

Objective	Addressed	Explanation
Implement Weighted Close Indicator [#242]	✅
Implement Weighted Close calculation formula	✅
Provide strategy for trading signals	✅

Possibly related PRs

• Smoothed Moving Average (SMMA) Strategy added. #249: Addition of Smoothed Moving Average (SMMA) Strategy
• Added support for SMMA. #247: Addition of Smoothed Moving Average (SMMA) Indicator

Poem

🐰 A Rabbit's Ode to Weighted Close 🚀

In markets where prices dance and sway,
Weighted Close shows the trader's way
High, low, and close in harmony blend
A signal of trends that might descend or ascend
Technical wisdom, rabbit-style insight! 📈

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[codecov-commenter]

Codecov Report

Attention: Patch coverage is 98.98990% with 1 line in your changes missing coverage. Please review.

Project coverage is 93.63%. Comparing base (780ba99) to head (cf59746).

Files with missing lines	Patch %	Lines
strategy/trend/trend.go	0.00%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master     #263      +/-   ##
==========================================
+ Coverage   93.54%   93.63%   +0.08%     
==========================================
  Files         176      178       +2     
  Lines        6277     6376      +99     
==========================================
+ Hits         5872     5970      +98     
- Misses        345      346       +1     
  Partials       60       60              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.