add new readme.rmd

.Rbuildignore

@@ -1,2 +1,4 @@
 ^.*\.Rproj$
 ^\.Rproj\.user$
+^README\.Rmd$
+^README-.*\.png$

M4comp2018.Rproj

@@ -0,0 +1,17 @@
+Version: 1.0
+
+RestoreWorkspace: Default
+SaveWorkspace: Default
+AlwaysSaveHistory: Default
+
+EnableCodeIndexing: Yes
+UseSpacesForTab: Yes
+NumSpacesForTab: 2
+Encoding: UTF-8
+
+RnwWeave: Sweave
+LaTeX: pdfLaTeX
+
+BuildType: Package
+PackageUseDevtools: Yes
+PackageInstallArgs: --no-multiarch --with-keep.source

README.md

@@ -0,0 +1,39 @@
+
+<!-- README.md is generated from README.Rmd. Please edit that file -->
+M4comp2018
+==========
+
+The R package M4comp2018 contains the 100000 time series from the M4-competition.
+
+Installation
+------------
+
+You can install M4comp2018 from github with:
+
+``` r
+# install.packages("devtools")
+devtools::install_github("carlanetto/M4comp2018")
+```
+
+Example
+-------
+
+This is a basic example which shows you how to solve a common problem:
+
+``` r
+## basic example code
+library(M4comp2018)
+data(M4)
+names(M4[[1]])
+#> [1] "x"      "st"     "type"   "period" "h"      "sn"
+#extract yearly series
+yearly_M4 <- Filter(function(l) l$period == "Yearly", M4)
+```
+
+``` r
+library(ggplot2)
+library(forecast)
+autoplot(M4[[40773]]$x)
+```
+
+![](README-unnamed-chunk-3-1.png)

README.rmd

@@ -1,3 +1,17 @@
+---
+output: github_document
+---
+
+<!-- README.md is generated from README.Rmd. Please edit that file -->
+
+```{r, echo = FALSE}
+knitr::opts_chunk$set(
+  collapse = TRUE,
+  comment = "#>",
+  fig.path = "README-"
+)
+```
+
 # M4comp2018
 
 The R package M4comp2018 contains the 100000 time series from the M4-competition. 
@@ -6,12 +20,12 @@ The R package M4comp2018 contains the 100000 time series from the M4-competition
 
 You can install M4comp2018 from github with:
 
-
-``` r
+```{r gh-installation, eval = FALSE}
 # install.packages("devtools")
 devtools::install_github("carlanetto/M4comp2018")
 ```
 
+
 ## Example
 
 This is a basic example which shows you how to solve a common problem:
@@ -28,5 +42,7 @@ yearly_M4 <- Filter(function(l) l$period == "Yearly", M4)
 ```{r}
 library(ggplot2)
 library(forecast)
-autoplot(M4[[10000]]$x)
+autoplot(M4[[40773]]$x)
 ```
+
+