rte-antares-rpackage · berthetclement · Apr 20, 2023 · Apr 27, 2023 · Apr 27, 2023 · May 5, 2023
diff --git a/.github/workflows/pkgdown.yaml b/.github/workflows/pkgdown.yaml
@@ -0,0 +1,48 @@
+# Workflow derived from https://github.com/r-lib/actions/tree/v2/examples
+# Need help debugging build failures? Start at https://github.com/r-lib/actions#where-to-find-help
+on:
+  push:
+    branches: [main, master, test_doc]
+  pull_request:
+    branches: [main, master, test_doc]
+  release:
+    types: [published]
+  workflow_dispatch:
+
+name: pkgdown
+
+jobs:
+  pkgdown:
+    runs-on: ubuntu-latest
+    # Only restrict concurrency for non-PR jobs
+    concurrency:
+      group: pkgdown-${{ github.event_name != 'pull_request' || github.run_id }}
+    env:
+      GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: r-lib/actions/setup-pandoc@v2
+
+      - uses: r-lib/actions/setup-r@v2
+        with:
+          use-public-rspm: true
+
+      - uses: r-lib/actions/setup-r-dependencies@v2
+        with:
+          extra-packages: any::pkgdown, local::.
+          needs: website
+
+      - name: Build site
+        run: pkgdown::build_site_github_pages(new_process = FALSE, install = FALSE)
+        shell: Rscript {0}
+
+      - name: Deploy to GitHub pages 🚀
+        if: github.event_name != 'pull_request'
+        uses: JamesIves/[email protected]
+        with:
+          clean: false
+          branch: gh-pages
+          folder: docs
diff --git a/.gitignore b/.gitignore
@@ -10,3 +10,4 @@ revdep/library/
 /doc/
 /Meta/
 *.Rproj
+^docs$
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -1,7 +1,7 @@
 Package: antaresRead
 Type: Package
 Title: Import, Manipulate and Explore the Results of an 'Antares' Simulation
-Version: 2.6.1
+Version: 2.7.0
 Authors@R: c(
     person("Tatiana", "Vargas", email = "[email protected]", role = c("aut", "cre")),
     person("Jalal-Edine", "ZAWAM", role = "aut"),
@@ -18,7 +18,7 @@ Authors@R: c(
 Description: Import, manipulate and explore results generated by 'Antares', a 
     powerful open source software developed by RTE (Réseau de Transport d’Électricité) to simulate and study electric power systems
     (more information about 'Antares' here : <https://antares-simulator.org/>).
-URL: https://github.com/rte-antares-rpackage/antaresRead
+URL: https://github.com/rte-antares-rpackage/antaresRead, https://rte-antares-rpackage.github.io/antaresRead/
 BugReports: https://github.com/rte-antares-rpackage/antaresRead/issues
 License: GPL (>= 2) | file LICENSE 
 Imports:
@@ -37,7 +37,8 @@ Imports:
     httr,
     utils,
     memuse,
-    purrr
+    purrr,
+    lifecycle
 Suggests:
     rhdf5 (>= 2.24.0),
     testthat,

diff --git a/NAMESPACE b/NAMESPACE
@@ -1,119 +1,120 @@
-# Generated by roxygen2: do not edit by hand
-
-S3method("[",antaresDataTable)
-S3method(as.antaresDataList,antaresDataList)
-S3method(as.antaresDataList,antaresDataTable)
-S3method(as.antaresDataList,data.frame)
-S3method(as.antaresDataList,default)
-S3method(as.antaresDataList,list)
-S3method(as.antaresDataTable,antaresDataTable)
-S3method(as.antaresDataTable,data.frame)
-S3method(as.antaresDataTable,default)
-S3method(copyToClipboard,antaresDataList)
-S3method(copyToClipboard,data.frame)
-S3method(copyToClipboard,default)
-S3method(copyToClipboard,matrix)
-S3method(merge,antaresDataTable)
-S3method(print,antaresDataList)
-S3method(print,antaresDataTable)
-S3method(print,simOptions)
-S3method(subset,antaresDataList)
-S3method(summary,bindingConstraints)
-S3method(viewAntares,antaresDataList)
-S3method(viewAntares,default)
-export(.getOptionsH5)
-export(.h5ReadAntares)
-export(.writeAntaresH5Fun)
-export(aggregateResult)
-export(api_delete)
-export(api_get)
-export(api_post)
-export(api_put)
-export(as.antaresDataList)
-export(as.antaresDataTable)
-export(changeTimeStep)
-export(copyToClipboard)
-export(extractDataList)
-export(getAlias)
-export(getAreas)
-export(getDistricts)
-export(getGeographicTrimming)
-export(getIdCols)
-export(getLinks)
-export(hvdcModification)
-export(isH5Opts)
-export(mergeDigests)
-export(parAggregateMCall)
-export(ponderateMcAggregation)
-export(readAntares)
-export(readAntaresAreas)
-export(readAntaresClusters)
-export(readBindingConstraints)
-export(readClusterDesc)
-export(readClusterResDesc)
-export(readClusterSTDesc)
-export(readDigestFile)
-export(readIni)
-export(readIniAPI)
-export(readIniFile)
-export(readInputRES)
-export(readInputTS)
-export(readInputThermal)
-export(readLayout)
-export(readOptimCriteria)
-export(removeVirtualAreas)
-export(setAlias)
-export(setHvdcAreas)
-export(setRam)
-export(setSimulationPath)
-export(setSimulationPathAPI)
-export(setTimeoutAPI)
-export(showAliases)
-export(simOptions)
-export(viewAntares)
-export(writeAntaresH5)
-export(writeDigest)
-import(bit64)
-import(data.table)
-import(doParallel)
-import(jsonlite)
-import(parallel)
-import(plyr)
-importFrom(doParallel,registerDoParallel)
-importFrom(grDevices,col2rgb)
-importFrom(grDevices,rgb)
-importFrom(httr,DELETE)
-importFrom(httr,GET)
-importFrom(httr,POST)
-importFrom(httr,PUT)
-importFrom(httr,accept_json)
-importFrom(httr,add_headers)
-importFrom(httr,content)
-importFrom(httr,content_type_json)
-importFrom(httr,http_status)
-importFrom(httr,stop_for_status)
-importFrom(httr,timeout)
-importFrom(memuse,Sys.meminfo)
-importFrom(methods,is)
-importFrom(pbapply,pblapply)
-importFrom(pbapply,pboptions)
-importFrom(plyr,llply)
-importFrom(purrr,quietly)
-importFrom(shiny,getDefaultReactiveDomain)
-importFrom(shiny,incProgress)
-importFrom(shiny,withProgress)
-importFrom(stats,as.formula)
-importFrom(stats,setNames)
-importFrom(stats,weighted.mean)
-importFrom(stringi,stri_replace_last_fixed)
-importFrom(stringr,str_match)
-importFrom(stringr,str_replace)
-importFrom(stringr,str_split)
-importFrom(utils,URLencode)
-importFrom(utils,View)
-importFrom(utils,read.table)
-importFrom(utils,setTxtProgressBar)
-importFrom(utils,txtProgressBar)
-importFrom(utils,type.convert)
-importFrom(utils,untar)
-importFrom(utils,write.table)
+# Generated by roxygen2: do not edit by hand
+
+S3method("[",antaresDataTable)
+S3method(as.antaresDataList,antaresDataList)
+S3method(as.antaresDataList,antaresDataTable)
+S3method(as.antaresDataList,data.frame)
+S3method(as.antaresDataList,default)
+S3method(as.antaresDataList,list)
+S3method(as.antaresDataTable,antaresDataTable)
+S3method(as.antaresDataTable,data.frame)
+S3method(as.antaresDataTable,default)
+S3method(copyToClipboard,antaresDataList)
+S3method(copyToClipboard,data.frame)
+S3method(copyToClipboard,default)
+S3method(copyToClipboard,matrix)
+S3method(merge,antaresDataTable)
+S3method(print,antaresDataList)
+S3method(print,antaresDataTable)
+S3method(print,simOptions)
+S3method(subset,antaresDataList)
+S3method(summary,bindingConstraints)
+S3method(viewAntares,antaresDataList)
+S3method(viewAntares,default)
+export(.getOptionsH5)
+export(.h5ReadAntares)
+export(.writeAntaresH5Fun)
+export(aggregateResult)
+export(api_delete)
+export(api_get)
+export(api_post)
+export(api_put)
+export(as.antaresDataList)
+export(as.antaresDataTable)
+export(changeTimeStep)
+export(copyToClipboard)
+export(extractDataList)
+export(getAlias)
+export(getAreas)
+export(getDistricts)
+export(getGeographicTrimming)
+export(getIdCols)
+export(getLinks)
+export(hvdcModification)
+export(isH5Opts)
+export(mergeDigests)
+export(parAggregateMCall)
+export(ponderateMcAggregation)
+export(readAntares)
+export(readAntaresAreas)
+export(readAntaresClusters)
+export(readBindingConstraints)
+export(readClusterDesc)
+export(readClusterResDesc)
+export(readClusterSTDesc)
+export(readDigestFile)
+export(readIni)
+export(readIniAPI)
+export(readIniFile)
+export(readInputRES)
+export(readInputTS)
+export(readInputThermal)
+export(readLayout)
+export(readOptimCriteria)
+export(removeVirtualAreas)
+export(setAlias)
+export(setHvdcAreas)
+export(setRam)
+export(setSimulationPath)
+export(setSimulationPathAPI)
+export(setTimeoutAPI)
+export(showAliases)
+export(simOptions)
+export(viewAntares)
+export(writeAntaresH5)
+export(writeDigest)
+import(bit64)
+import(data.table)
+import(doParallel)
+import(jsonlite)
+import(parallel)
+import(plyr)
+importFrom(doParallel,registerDoParallel)
+importFrom(grDevices,col2rgb)
+importFrom(grDevices,rgb)
+importFrom(httr,DELETE)
+importFrom(httr,GET)
+importFrom(httr,POST)
+importFrom(httr,PUT)
+importFrom(httr,accept_json)
+importFrom(httr,add_headers)
+importFrom(httr,content)
+importFrom(httr,content_type_json)
+importFrom(httr,http_status)
+importFrom(httr,stop_for_status)
+importFrom(httr,timeout)
+importFrom(lifecycle,deprecated)
+importFrom(memuse,Sys.meminfo)
+importFrom(methods,is)
+importFrom(pbapply,pblapply)
+importFrom(pbapply,pboptions)
+importFrom(plyr,llply)
+importFrom(purrr,quietly)
+importFrom(shiny,getDefaultReactiveDomain)
+importFrom(shiny,incProgress)
+importFrom(shiny,withProgress)
+importFrom(stats,as.formula)
+importFrom(stats,setNames)
+importFrom(stats,weighted.mean)
+importFrom(stringi,stri_replace_last_fixed)
+importFrom(stringr,str_match)
+importFrom(stringr,str_replace)
+importFrom(stringr,str_split)
+importFrom(utils,URLencode)
+importFrom(utils,View)
+importFrom(utils,read.table)
+importFrom(utils,setTxtProgressBar)
+importFrom(utils,txtProgressBar)
+importFrom(utils,type.convert)
+importFrom(utils,untar)
+importFrom(utils,write.table)
diff --git a/NEWS.md b/NEWS.md
@@ -1,5 +1,17 @@
 > Copyright © 2016 RTE Réseau de transport d’électricité
 
+# antaresRead 2.7.0
+
+### Breaking changes (Antares v8.7) : 
+
+* `readBindingConstraints()` read now Scenarized RHS for binding constraints (cf. Antares v8.7 changelog)
+  - function returns a new list structure
+
+BUGFIXES :  
+
+* `readBindingConstraints()` read well study >= v8.3.2
+
+
 # antaresRead 2.6.1 (devlopment)
 
 BUGFIXES :  

diff --git a/R/antaresRead-package.R b/R/antaresRead-package.R
@@ -0,0 +1,7 @@
+#' @keywords internal
+"_PACKAGE"
+
+## usethis namespace: start
+#' @importFrom lifecycle deprecated
+## usethis namespace: end
+NULL
-Original file line number
+Diff line change
@@ Expand Up / @@ -10,3 +10,4 @@ revdep/library/ @@
     /doc/
     /Meta/
     *.Rproj
+    ^docs$