README.Rmd

---
output: github_document
---

<!-- README.md is generated from README.Rmd. Please edit that file -->

```{r, include = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-",
  out.width = "100%"
)
```

# tidytrading

<!-- badges: start -->
[![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental)
[![CRAN status](https://www.r-pkg.org/badges/version/tidytrading)](https://CRAN.R-project.org/package=tidytrading)
[![R-CMD-check](https://github.com/quantargo/tidytrading/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/quantargo/tidytrading/actions/workflows/R-CMD-check.yaml)
<!-- badges: end -->

The goal of tidytrading is to ...

## Installation

You can install the development version of tidytrading like so:

``` r
remotes::install_github("tidytrading")
```

## Example

This is a basic example which shows you how to backtest an EMA 50/200 Cross (Long-only) strategy on the S&P 500:

```{r example, eval=FALSE}
library(tidytrading)
library(recipes)
library(TTR)

port <- get_symbols("^GSPC", from="2007-01-01")
rec <- recipe(port) |>
  step_mutate(ma50 = EMA(close, n = 50)) |>
  step_mutate(ma200 = EMA(close, n = 200))

strat <- function(.data, position, ...) {
  open_orders <- tail(.data, 1) |>
    mutate(target_qty = ifelse(ma50 > ma200), 100, 0) |>
    inner_join(position, by = "symbol") |>
    mutate(order_qty = target_qty - position_qty) |>
    filter(order_qty != 0)
  order(sym = open_orders$symbol,
        qty=open_orders$order_qty, type="market")
}

# Under construction:
samp <- sliding_window(port, lookback = 300)
multi_metric <- metric_set(sharpe, maxdd, ccc_with_bias)
order_txn <- backtest(strat, data = rec, resamples = samp)
order_txn |> multi_metric() # Calculate metrics
order_txn |> autoplot() # Plot similar to blotter::chart.Posn
```