Added vignette

.gitignore

@@ -3,3 +3,4 @@
 .RData
 .Ruserdata
 test_case/
+inst/doc

DESCRIPTION

@@ -25,5 +25,9 @@ Imports:
     grDevices,
     data.table,
     whisker
-Suggests: testthat,
-    covr
+Suggests: 
+    testthat,
+    covr,
+    knitr,
+    rmarkdown
+VignetteBuilder: knitr

README.md

@@ -4,7 +4,7 @@
 # antaresEditObject
 
 
-> Edit an Antares study before running simulation. Methods are provided to create (and remove) area, links between them, thermal cluster and binding constraints. These steps maybe usefull before running an Antares simulation.
+> Edit an Antares study before running a simulation.
 
 
 [![Travis-CI Build Status](https://travis-ci.org/rte-antares-rpackage/antaresEditObject.svg?branch=master)](https://travis-ci.org/rte-antares-rpackage/antaresEditObject)
@@ -25,211 +25,21 @@ Install from CRAN:
 install.packages("antaresEditObject")
 ```
 
-Or install dev version from GitHub :
+Or install dev version from GitHub:
 
 ```r
-remotes::install_github("rte-antares-rpackage/antaresEditObject")
+remotes::install_github("rte-antares-rpackage/antaresEditObject", build_vignettes = TRUE)
 ```
 
 
+## Goal
 
-## Prerequisites
-
-You need to set the path to an Antares simulation in "input" mode :
-
-```r
-antaresRead::setSimulationPath(path = "path/to/study", simulation = "input")
-```
-
-Or you can simply create a new study :
-
-```r
-createStudy("path/to/study")
-```
-
-
-
-## Save simulation
-
-Before modifying your simulation, you can save it in an archive :
-
-```r
-backupStudy(what = "input")
-```
-
-This will create a `.tar.gz` file in your simulation folder.
-
-
-
-## Create a new area
-
-You can create a new area with :
-
-```r
-library("antaresEditObject")
-
-createArea(name = "myarea")
-
-# The new area should appear here :
-antaresRead::getAreas()
-
-```
-
-You can specify the localization of the area on the map, and also color.
-
-There are two helper function for area parameters :
-
-* `filteringOptions()` for filtering options, like `filter-year-by-year`
-* `nodalOptimizationOptions()` for nodal optimizations options.
-
-
-
-## Create a new cluster
-
-You can initialize a cluster with some parameters :
-
-```r
-createCluster(
-  area = "myarea", 
-  cluster_name = "myareacluster",
-  group = "other",
-  unitcount = 1,
-  nominalcapacity = 8400,
-  `min-down-time` = 0,
-  `marginal-cost` = 0.010000,
-  `market-bid-cost` = 0.010000
-)
-```
-
-You can edit the settings of an existing cluster :
-
-```r
-editCluster(
-  area = "myarea", 
-  cluster_name = "myareacluster", 
-  nominalcapacity = 10600.000
-)
-```
-
-
-## Create a new link
-
-```r
-createLink(
-  from = "area1", 
-  to = "area2", 
-  propertiesLink = propertiesLinkOptions(
-    hurdles_cost = FALSE,
-    transmission_capacities = "enabled"
-  ), 
-  dataLink = NULL
-)
-```
-
-You can edit the settings of an existing link :
-
-```r
-editLink(
-  from = "area1",
-  to = "area2",
-  transmission_capacities = "infinite"
-)
-```
-
-
-
-## Create a binding constraint
-
-```r
-createBindingConstraint(
-  name = "myconstraint", 
-  values = matrix(data = c(rep(c(19200, 0, 0), each = 366)), ncol = 3), 
-  enabled = FALSE, 
-  timeStep = "daily",
-  operator = "both",
-  coefficients = c("fr%myarea" = 1)
-)
-```
-
-## Create several Pumped Storage Power plant (PSP)
-
-```r
-pspData <- data.frame(
-  area = c("a", "b"), 
-  installedCapacity = c(800,900)
-)
-
-createPSP(
-  areasAndCapacities = pspData, 
-  efficiency = 0.75
-)
-```
-
-## Create several Demand Side Response (DSR)
-
-```r
-dsrData <- data.frame(
-  area = c("a", "b"),
-  unit = c(10,20), 
-  nominalCapacity = c(100, 120),
-  marginalCost = c(52, 65),
-  hour = c(3, 7)
-)
-
-createDSR(dsrData)
-
-```
-
-
-## Update general settings
-
-For example, set the output of simulation year by year, and limit the number of Monte-Carlo years to 10 :
-
-```r
-updateGeneralSettings(year.by.year = TRUE, nbyears = 10)
-```
-
-
-## Remove methods
-
-You can remove from input folder areas, links, clusters and binding constraints with `remove*` functions, e.g. :
-
-```r
-removeArea("myarea")
-```
-
-
-## Run Time-Series Generator
-
-First, update general settings to activate time series to generate :
-
-```r
-updateGeneralSettings(generate = "thermal")
-```
-
-Then run TS-generator:
-
-```r
-runTsGenerator(
-  path_solver = "C:/path/to/antares-solver.exe", 
-  show_output_on_console = TRUE
-)
-```
-
-
-## Run an Antares simulation
-
-Launch an Antares simulation from R :
-
-```r
-runSimulation(
-  name = "myAwesomeSimulation", 
-  mode = "economy",
-  path_solver = "C:/path/to/antares-solver.exe", 
-  show_output_on_console = TRUE
-)
-```
+This package allows to edit an Antares study. Methods are provided to create
+(and remove) areas, links between them, thermal clusters and binding
+constraints. These steps may be useful before running an Antares simulation.
 
 
+## Usage
 
+Usage of the package is detailed in the vignette: `vignette("antaresEditObject")`.
 

vignettes/.gitignore

@@ -0,0 +1,2 @@
+*.html
+*.R