From 3ca704eae4ab5324e942833c5522d16433722100 Mon Sep 17 00:00:00 2001 From: eblondel Date: Wed, 22 May 2024 20:23:12 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20eblondel?= =?UTF-8?q?/zen4R@7f4ae34082ba867f60357897f3763b0d5169fc0d=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- pkgdown.yml | 2 +- reference/ZenodoManager.html | 122 ++++++++++++++++++++++++++++++++++- reference/get_zenodo.html | 12 ++-- 3 files changed, 127 insertions(+), 9 deletions(-) diff --git a/pkgdown.yml b/pkgdown.yml index a9f2016..ebaa4a0 100644 --- a/pkgdown.yml +++ b/pkgdown.yml @@ -3,5 +3,5 @@ pkgdown: 2.0.9 pkgdown_sha: ~ articles: zen4R: zen4R.html -last_built: 2024-05-22T15:05Z +last_built: 2024-05-22T20:22Z diff --git a/reference/ZenodoManager.html b/reference/ZenodoManager.html index bc69846..f980e13 100644 --- a/reference/ZenodoManager.html +++ b/reference/ZenodoManager.html @@ -148,6 +148,11 @@

Public methods

ZenodoManager$getRecordByDOI()

  • ZenodoManager$getRecordById()

  • ZenodoManager$getRecordByConceptId()

    • +

  • ZenodoManager$getRequest()

    • +

  • ZenodoManager$isActionableRequest()

    • +

  • ZenodoManager$acceptRequest()

    • +

  • ZenodoManager$declineRequest()

    • +

  • ZenodoManager$cancelRequest()

  • ZenodoManager$clone()

    • Inherited methods
    • zen4R::zen4RLogger$ERROR()
    • zen4R::zen4RLogger$INFO()
      • @@ -1378,15 +1383,128 @@

      Returns
      +

      Method getRequest()

      +

      Get a request

      +

      Usage

      +

      ZenodoManager$getRequest(request_id)

      +
      + +
      +

      Arguments

      +

      request_id
      +

      the request ID

      + + +

      +
      +
      +

      Returns

      +

      the request list object, NULL otherwise

      +
      + +

      +

      Method isActionableRequest()

      +

      Checks if the request can be subject to an operation (accept, decline, cancel) +depending on its status. To be subject to an operation, a request should not be closed or expired

      +

      Usage

      +

      ZenodoManager$isActionableRequest(request_id)

      +
      + +
      +

      Arguments

      +

      request_id
      +

      the request ID

      + + +

      +
      +
      +

      Returns

      +

      TRUE if

      +
      + +

      +

      Method acceptRequest()

      +

      Accepts a request

      +

      Usage

      +

      ZenodoManager$acceptRequest(request_id, message = NULL)

      +
      + +
      +

      Arguments

      +

      request_id
      +

      the request ID

      + + +
      message
      +

      optional message reason for acceptance

      + + +

      +
      +
      +

      Returns

      +

      TRUE if accepted, FALSE otherwise

      +
      + +

      +

      Method declineRequest()

      +

      Declines a request

      +

      Usage

      +

      ZenodoManager$declineRequest(request_id, message = NULL)

      +
      + +
      +

      Arguments

      +

      request_id
      +

      the request ID

      + + +
      message
      +

      optional message reason for declination

      + + +

      +
      +
      +

      Returns

      +

      TRUE if declined, FALSE otherwise

      +
      + +

      +

      Method cancelRequest()

      +

      Cancels a request

      +

      Usage

      +

      ZenodoManager$cancelRequest(request_id, message = NULL)

      +
      + +
      +

      Arguments

      +

      request_id
      +

      the request ID

      + + +
      message
      +

      optional message reason for cancelation

      + + +

      +
      +
      +

      Returns

      +

      TRUE if canceled, FALSE otherwise

      +
      +

      Method clone()

      The objects of this class are cloneable with this method.

      -

      Usage

      +

      Usage

      ZenodoManager$clone(deep = FALSE)

      -

      Arguments

      +

      Arguments

      deep

      Whether to make a deep clone.

      diff --git a/reference/get_zenodo.html b/reference/get_zenodo.html index f43c853..2901cb2 100644 --- a/reference/get_zenodo.html +++ b/reference/get_zenodo.html @@ -199,16 +199,16 @@

      Examples

      #> ............|-- identifier: oai:zenodo.org:6656251 #> ............|-- provider: oai #> ....|-- stats: -#> ↓ this_version.downloads = 57 -#> ↓ this_version.unique_downloads = 24 -#> ↓ all_versions.downloads = 1488 -#> ↓ all_versions.unique_downloads = 652 +#> ↓ this_version.downloads = 61 +#> ↓ this_version.unique_downloads = 26 +#> ↓ all_versions.downloads = 1492 +#> ↓ all_versions.unique_downloads = 654 #> 👁 this_version.views = 108 #> 👁 this_version.unique_views = 106 #> 👁 all_versions.views = 1607 #> 👁 all_versions.unique_views = 1444 -#> ■ this_version.data_volume = 3333640 -#> ■ all_versions.data_volume = 53705213 +#> ■ this_version.data_volume = 3568068 +#> ■ all_versions.data_volume = 53939641 # }