update docs

Author: pvictor

DESCRIPTION

@@ -1,7 +1,7 @@
 Package: antaresEditObject
 Type: Package
 Title: Edit an 'Antares' Simulation
-Version: 0.1.3
+Version: 0.1.4
 Authors@R: c(
     person("Victor", "Perrier", email = "[email protected]", role = c("aut", "cre")),
     person("Baptiste", "Seguinot", email = "[email protected]", role = "ctb"),

R/editLink.R

@@ -40,7 +40,11 @@
 #'
 #' @examples
 #' \dontrun{
-#' createLink(from = "myarea", to  = "myarea2")
+#' editLink(
+#'   from = "area1",
+#'   to = "area2",
+#'   transmission_capacities = "infinite"
+#' )
 #' }
 editLink <- function(from, to, hurdles_cost = NULL, 
                      transmission_capacities = NULL, 

README.md

@@ -37,6 +37,14 @@ You need to set the path to an Antares simulation in "input" mode :
 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 :
@@ -78,7 +86,7 @@ You can initialize a cluster with some parameters :
 
 ```r
 createCluster(
-  area = "fr", 
+  area = "myarea", 
   cluster_name = "myareacluster",
   group = "other",
   unitcount = 1,
@@ -89,13 +97,23 @@ createCluster(
 )
 ```
 
+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 = "fr", 
-  to = "myarea", 
+  from = "area1", 
+  to = "area2", 
   propertiesLink = propertiesLinkOptions(
     hurdles_cost = FALSE,
     transmission_capacities = "enabled"
@@ -104,6 +122,16 @@ createLink(
 )
 ```
 
+You can edit the settings of an existing link :
+
+```r
+editLink(
+  from = "area1",
+  to = "area2",
+  transmission_capacities = "infinite"
+)
+```
+
 
 
 ## Create a binding constraint
@@ -167,3 +195,19 @@ removeArea("myarea")
 ```
 
 
+## 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
+)
+```
+
+
+
+

antaresEditObject.Rproj

@@ -15,6 +15,4 @@ LaTeX: pdfLaTeX
 BuildType: Package
 PackageUseDevtools: Yes
 PackageInstallArgs: --no-multiarch --with-keep.source
-PackageBuildArgs: --keep-empty-dirs
-PackageBuildBinaryArgs: --keep-empty-dirs
 PackageRoxygenize: rd,collate,namespace