From d1761e177b430400788541a0c609435bd4d55a1c Mon Sep 17 00:00:00 2001 From: berthetclement Date: Tue, 27 Feb 2024 10:07:07 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20rte-anta?= =?UTF-8?q?res-rpackage/antaresRead@104074e4307f7c4af844d82ff335ae64838a58?= =?UTF-8?q?e6=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- articles/antaresH5.html | 2 +- articles/antaresRead.html | 2 +- news/index.html | 3 +++ pkgdown.yml | 2 +- reference/API-methods.html | 25 ++++++++++++++++++++----- 5 files changed, 26 insertions(+), 8 deletions(-) diff --git a/articles/antaresH5.html b/articles/antaresH5.html index 23d5f5b9..4777efdc 100644 --- a/articles/antaresH5.html +++ b/articles/antaresH5.html @@ -85,7 +85,7 @@

Use h5 file format with ‘antaresRead’

Titouan Robert

-

2024-02-16

+

2024-02-27

Source: vignettes/antaresH5.Rmd diff --git a/articles/antaresRead.html b/articles/antaresRead.html index a8f86d74..c3850a6a 100644 --- a/articles/antaresRead.html +++ b/articles/antaresRead.html @@ -85,7 +85,7 @@

The ‘antaresRead’ Package

François Guillem

-

2024-02-16

+

2024-02-27

Source: vignettes/antaresRead.Rmd diff --git a/news/index.html b/news/index.html index e0be604c..887cc1a3 100644 --- a/news/index.html +++ b/news/index.html @@ -75,6 +75,9 @@

an
  • Correction in .formatlist(), read N-level list instead of 2.
    • +

    BREAKING CHANGES :

    +

    antaresRead 2.6.02023-08-30

    diff --git a/pkgdown.yml b/pkgdown.yml index bf69e785..67812f8f 100644 --- a/pkgdown.yml +++ b/pkgdown.yml @@ -4,5 +4,5 @@ pkgdown_sha: ~ articles: antaresH5: antaresH5.html antaresRead: antaresRead.html -last_built: 2024-02-16T09:05Z +last_built: 2024-02-27T10:06Z diff --git a/reference/API-methods.html b/reference/API-methods.html index c41f61b5..9eacbe6c 100644 --- a/reference/API-methods.html +++ b/reference/API-methods.html @@ -66,7 +66,13 @@

    API methods

    - 
    api_get(opts, endpoint, ..., default_endpoint = "v1/studies")
+    
    api_get(
+  opts,
+  endpoint,
+  ...,
+  default_endpoint = "v1/studies",
+  parse_result = NULL
+)
 
 api_post(opts, endpoint, ..., default_endpoint = "v1/studies")
 
@@ -93,6 +99,10 @@ 
    Arguments
    
 
    default_endpoint
    
 
    Default endpoint to use.
    
 
+
+
    parse_result
    
+
    character options for parameter as of function httr::content()
    
+
 
    
     
    
     
    Value
    
@@ -106,10 +116,15 @@ 
    Examples
    
     
    if (FALSE) {
 
 # List studies with local API
-api_get(
-  opts = list(host = "http://0.0.0.0:8080"),
-  endpoint = NULL
-)
+# default result content in R object (auto parsed)
+api_get(opts = list(host = "http://0.0.0.0:8080"),
+        endpoint = NULL, 
+        parse_result = NULL)
+
+# you can force parse options as text
+api_get(opts = list(host = "http://0.0.0.0:8080"),
+        endpoint = NULL, 
+        parse_result = "text")
 
 }