README.rmd

---
output: github_document
---

```{r setup, include=FALSE}
knitr::opts_chunk$set(echo = TRUE)
```


# Portfolio Tracker <a href=''><img src='man/figures/hex-PT.png' align="right" height="120" style="float:right; height:120px;" /></a>

<!-- badges: start -->
[![Lifecycle:
experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental)
[![Project Status: WIP – Initial development is in progress, but there
has not yet been a stable, usable release suitable for the
public.](https://www.repostatus.org/badges/latest/wip.svg)](https://www.repostatus.org/#wip)
[![R-CMD-check](https://github.com/lorenzbr/PortfolioTracker/workflows/R-CMD-check/badge.svg)](https://github.com/lorenzbr/PortfolioTracker/actions)
[![Codecov test coverage](https://codecov.io/gh/lorenzbr/PortfolioTracker/branch/main/graph/badge.svg)](https://codecov.io/gh/lorenzbr/PortfolioTracker?branch=main)
<!-- badges: end -->

This R package contains functions to track the performance of your investment portfolio. It is the back end of the Shiny App Portfolio Tracker. You can have a look at the documentation: [Portfolio Tracker](https://github.com/lorenzbr/PortfolioTrackerDocs).


## Installation

There is no need to install this package. However, if you are interested, you can install the development version:

```R
devtools::install_github("lorenzbr/PortfolioTracker")
```


## Usage

Please have a look at the documentation of the app: [Portfolio Tracker](https://github.com/lorenzbr/PortfolioTrackerDocs).


## Contact

Please contact <lorenz.brachtendorf@gmx.de> if you want to:

* contribute to this project
* have additional features (e.g., returns on investments, cash reserves, other currencies, ...)

You can also submit bug reports and suggestions via e-mail or <https://github.com/lorenzbr/PortfolioTracker/issues> 


## License

This R package is licensed under the GNU General Public License v3.0.

See [here](https://github.com/lorenzbr/PortfolioTracker/blob/main/LICENSE) for further information.