From f2c5d150bba3058b5f56830301810f90d888cdfb Mon Sep 17 00:00:00 2001 From: eblondel Date: Wed, 13 Mar 2024 21:46:43 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20eblondel?= =?UTF-8?q?/zen4R@e254b659ee822a41ea628e551ac30e377cd68989=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 | 255 +++++++++++++---------- reference/ZenodoRecord.html | 357 +++++++++++++++++---------------- reference/download_zenodo.html | 12 +- reference/get_versions.html | 22 +- reference/get_zenodo.html | 92 ++++----- reference/test.bib | 12 +- 7 files changed, 407 insertions(+), 345 deletions(-) diff --git a/pkgdown.yml b/pkgdown.yml index c9df4ac..1bab2c4 100644 --- a/pkgdown.yml +++ b/pkgdown.yml @@ -3,5 +3,5 @@ pkgdown: 2.0.7 pkgdown_sha: ~ articles: zen4R: zen4R.html -last_built: 2024-03-13T20:50Z +last_built: 2024-03-13T21:46Z diff --git a/reference/ZenodoManager.html b/reference/ZenodoManager.html index 6eb4d98..0d8be13 100644 --- a/reference/ZenodoManager.html +++ b/reference/ZenodoManager.html @@ -104,6 +104,8 @@

Public methods

ZenodoManager$getLanguageById()

  • ZenodoManager$getLicenses()

  • ZenodoManager$getLicenseById()

    • +

  • ZenodoManager$getResourceTypes()

    • +

  • ZenodoManager$getResourceTypeById()

  • ZenodoManager$getCommunities()

  • ZenodoManager$getCommunityById()

  • ZenodoManager$getGrants()

    • @@ -284,15 +286,57 @@

    Returns
    +

    Method getResourceTypes()

    +

    Get Resource types supported by Zenodo.

    +

    Usage

    +

    ZenodoManager$getResourceTypes(pretty = TRUE)

    +
    + +
    +

    Arguments

    +

    pretty
    +

    Prettify the output. By default the argument pretty is set to +TRUE which will returns the list of resource types as data.frame. +Set pretty = FALSE to get the raw list of resource types

    + + +

    +
    +
    +

    Returns

    +

    list of resource types as data.frame or list

    +
    + +

    +

    Method getResourceTypeById()

    +

    Get resource type by Id.

    +

    Usage

    +

    ZenodoManager$getResourceTypeById(id)

    +
    + +
    +

    Arguments

    +

    id
    +

    resource type id

    + + +

    +
    +
    +

    Returns

    +

    the resource type

    +
    +

    Method getCommunities()

    Get Communities supported by Zenodo.

    -

    Usage

    +

    Usage

    ZenodoManager$getCommunities(pretty = TRUE, q = "", size = 500)

    -

    Arguments

    +

    Arguments

    pretty

    Prettify the output. By default the argument pretty is set to TRUE which will returns the list of communities as data.frame. @@ -312,19 +356,19 @@

    Arguments -

    Returns

    +

    Returns

    list of communities as data.frame or list

    Method getCommunityById()

    Get community by Id.

    -

    Usage

    +

    Usage

    ZenodoManager$getCommunityById(id)

    -

    Arguments

    +

    Arguments

    id

    community id

    @@ -332,19 +376,19 @@

    Arguments -

    Returns

    +

    Returns

    the community

    Method getGrants()

    Get Grants supported by Zenodo. DEPRECATED: replaced by getAwards

    -

    Usage

    +

    Usage

    ZenodoManager$getGrants(q = "", pretty = TRUE, size = 500)

    -

    Arguments

    +

    Arguments

    q

    an ElasticSearch compliant query, object of class character. Default is emtpy. Note that the Zenodo API restrains a maximum number of 10,000 records to be retrieved. Consequently, @@ -364,19 +408,19 @@

    Arguments -

    Returns

    +

    Returns

    list of grants as data.frame or list

    Method getAwards()

    Get Awards supported by Zenodo.

    -

    Usage

    +

    Usage

    ZenodoManager$getAwards(q = "", pretty = TRUE, size = 500)

    -

    Arguments

    +

    Arguments

    q

    an ElasticSearch compliant query, object of class character. Default is emtpy. Note that the Zenodo API restrains a maximum number of 10,000 records to be retrieved. Consequently, @@ -396,19 +440,19 @@

    Arguments -

    Returns

    +

    Returns

    list of awards as data.frame or list

    Method getGrantsByName()

    Get grants by name. DEPRECATED: replaced by getAwardByName

    -

    Usage

    +

    Usage

    ZenodoManager$getGrantsByName(name, pretty = TRUE)

    -

    Arguments

    +

    Arguments

    name

    name

    @@ -422,19 +466,19 @@

    Arguments -

    Returns

    +

    Returns

    list of grants as data.frame or list

    Method getAwardsByName()

    Get awards by name.

    -

    Usage

    +

    Usage

    ZenodoManager$getAwardsByName(name, pretty = TRUE)

    -

    Arguments

    +

    Arguments

    name

    name

    @@ -448,19 +492,19 @@

    Arguments -

    Returns

    +

    Returns

    list of awards as data.frame or list

    Method getGrantById()

    Get grant by Id.DEPRECATED: replaced by getAwardById

    -

    Usage

    +

    Usage

    ZenodoManager$getGrantById(id)

    -

    Arguments

    +

    Arguments

    id

    grant id

    @@ -468,19 +512,19 @@

    Arguments -

    Returns

    +

    Returns

    the grant

    Method getAwardById()

    Get award by Id.

    -

    Usage

    +

    Usage

    ZenodoManager$getAwardById(id)

    -

    Arguments

    +

    Arguments

    id

    award id

    @@ -488,19 +532,19 @@

    Arguments -

    Returns

    +

    Returns

    the award

    Method getFunders()

    Get Funders supported by Zenodo based on a query.

    -

    Usage

    +

    Usage

    ZenodoManager$getFunders(q = "", pretty = TRUE, size = 500)

    -

    Arguments

    +

    Arguments

    q

    an ElasticSearch compliant query, object of class character. Default is emtpy. Note that the Zenodo API restrains a maximum number of 10,000 records to be retrieved. Consequently, @@ -520,19 +564,19 @@

    Arguments -

    Returns

    +

    Returns

    list of funders as data.frame or list

    Method getFundersByName()

    Get funders by name.

    -

    Usage

    +

    Usage

    ZenodoManager$getFundersByName(name, pretty = TRUE)

    -

    Arguments

    +

    Arguments

    name

    name

    @@ -546,19 +590,19 @@

    Arguments -

    Returns

    +

    Returns

    list of funders as data.frame or list

    Method getFunderById()

    Get funder by Id.

    -

    Usage

    +

    Usage

    ZenodoManager$getFunderById(id)

    -

    Arguments

    +

    Arguments

    id

    funder id

    @@ -566,7 +610,7 @@

    Arguments -

    Returns

    +

    Returns

    the funder

    @@ -580,7 +624,7 @@

    Method getDepositions()https://help.zenodo.org/guides/search/.

    -

    Usage

    +

    Usage

    ZenodoManager$getDepositions(
   q = "",
   size = 10,
@@ -591,7 +635,7 @@ 
    Usage
 
 
    
-
    Arguments
    
+
    Arguments
    
 
    q
    
 
    Elastic-Search-compliant query, as object of class character. Default is ""
    
 
@@ -615,19 +659,19 @@ 
    Arguments
-
    Returns
    
+
    Returns
    
 
    a list of ZenodoRecord
    
 
    
 
 
    
 
    Method getDepositionByConceptDOI()
    
 
    Get a Zenodo deposition record by concept DOI (generic DOI common to all deposition record versions).
    
-
    Usage
    
+
    Usage
    
 
    ZenodoManager$getDepositionByConceptDOI(conceptdoi)
    
 
    
 
 
    
-
    Arguments
    
+
    Arguments
    
 
    conceptdoi
    
 
    the concept DOI, object of class character
    
 
@@ -635,19 +679,19 @@ 
    Arguments
-
    Returns
    
+
    Returns
    
 
    an object of class ZenodoRecord if record does exist, NULL otherwise
    
 
    
 
 
    
 
    Method getDepositionByDOI()
    
 
    Get a Zenodo deposition record by DOI.
    
-
    Usage
    
+
    Usage
    
 
    ZenodoManager$getDepositionByDOI(doi)
    
 
    
 
 
    
-
    Arguments
    
+
    Arguments
    
 
    doi
    
 
    the DOI, object of class character
    
 
@@ -655,19 +699,19 @@ 
    Arguments
-
    Returns
    
+
    Returns
    
 
    an object of class ZenodoRecord if record does exist, NULL otherwise
    
 
    
 
 
    
 
    Method getDepositionById()
    
 
    Get a Zenodo deposition record by ID.
    
-
    Usage
    
+
    Usage
    
 
    ZenodoManager$getDepositionById(recid)
    
 
    
 
 
    
-
    Arguments
    
+
    Arguments
    
 
    recid
    
 
    the record ID, object of class character
    
 
@@ -675,19 +719,19 @@ 
    Arguments
-
    Returns
    
+
    Returns
    
 
    an object of class ZenodoRecord if record does exist, NULL otherwise
    
 
    
 
 
    
 
    Method getDepositionByConceptId()
    
 
    Get a Zenodo deposition record by concept ID.
    
-
    Usage
    
+
    Usage
    
 
    ZenodoManager$getDepositionByConceptId(conceptrecid)
    
 
    
 
 
    
-
    Arguments
    
+
    Arguments
    
 
    conceptrecid
    
 
    the record concept ID, object of class character
    
 
@@ -695,19 +739,19 @@ 
    Arguments
-
    Returns
    
+
    Returns
    
 
    an object of class ZenodoRecord if record does exist, NULL otherwise
    
 
    
 
 
    
 
    Method depositRecord()
    
 
    Deposits a record on Zenodo.
    
-
    Usage
    
+
    Usage
    
 
    ZenodoManager$depositRecord(record, publish = FALSE)
    
 
    
 
 
    
-
    Arguments
    
+
    Arguments
    
 
    record
    
 
    the record to deposit, object of class ZenodoRecord
    
 
@@ -720,7 +764,7 @@ 
    Arguments
-
    Returns
    
+
    Returns
    
 
    TRUE if deposited (and eventually published), FALSE otherwise
    
 
    
 
@@ -728,7 +772,7 @@ 
    ReturnsMethod depositRecordVersion()
    
 
    Deposits a record version on Zenodo. For details about the behavior of this function, 
   see https://developers.zenodo.org/#new-version
    
-
    Usage
    
+
    Usage
    
 
    ZenodoManager$depositRecordVersion(
   record,
   delete_latest_files = TRUE,
@@ -738,7 +782,7 @@ 
    Usage
 
 
    
-
    Arguments
    
+
    Arguments
    
 
    record
    
 
    the record version to deposit, object of class ZenodoRecord
    
 
@@ -758,19 +802,19 @@ 
    Arguments
-
    Returns
    
+
    Returns
    
 
    TRUE if deposited (and eventually published), FALSE otherwise
    
 
    
 
 
    
 
    Method deleteRecord()
    
 
    Deletes a record given its ID
    
-
    Usage
    
+
    Usage
    
 
    ZenodoManager$deleteRecord(recordId)
    
 
    
 
 
    
-
    Arguments
    
+
    Arguments
    
 
    recordId
    
 
    the ID of the record to be deleted
    
 
@@ -778,19 +822,19 @@ 
    Arguments
-
    Returns
    
+
    Returns
    
 
    TRUE if deleted, FALSE otherwise
    
 
    
 
 
    
 
    Method deleteRecordByDOI()
    
 
    Deletes a record by DOI
    
-
    Usage
    
+
    Usage
    
 
    ZenodoManager$deleteRecordByDOI(doi)
    
 
    
 
 
    
-
    Arguments
    
+
    Arguments
    
 
    doi
    
 
    the DOI of the record to be deleted
    
 
@@ -798,7 +842,7 @@ 
    Arguments
-
    Returns
    
+
    Returns
    
 
    TRUE if deleted, FALSE otherwise
    
 
    
 
@@ -808,12 +852,12 @@ 
    Method deleteRecords()https://help.zenodo.org/guides/search/.
    
-
    Usage
    
+
    Usage
    
 
    ZenodoManager$deleteRecords(q = "", size = 10)
    
 
    
 
 
    
-
    Arguments
    
+
    Arguments
    
 
    q
    
 
    an ElasticSearch compliant query, object of class character
    
 
@@ -825,7 +869,7 @@ 
    Arguments
-
    Returns
    
+
    Returns
    
 
    TRUE if all records have been deleted, FALSE otherwise
    
 
    
 
@@ -834,24 +878,24 @@ 
    Method createEmptyRecord()Creates an empty record in the Zenodo deposit. Returns the record
    newly created in Zenodo, as an object of class ZenodoRecord with an 
    assigned identifier.
    
-
    Usage
    
+
    Usage
    
 
    ZenodoManager$createEmptyRecord()
    
 
    
 
 
    
-
    Returns
    
+
    Returns
    
 
    an object of class ZenodoRecord
    
 
    
 
 
    
 
    Method editRecord()
    
 
    Unlocks a record already submitted. Required to edit metadata of a Zenodo record already published.
    
-
    Usage
    
+
    Usage
    
 
    ZenodoManager$editRecord(recordId)
    
 
    
 
 
    
-
    Arguments
    
+
    Arguments
    
 
    recordId
    
 
    the ID of the record to unlock and set in editing mode.
    
 
@@ -859,19 +903,19 @@ 
    Arguments
-
    Returns
    
+
    Returns
    
 
    an object of class ZenodoRecord
    
 
    
 
 
    
 
    Method discardChanges()
    
 
    Discards changes on a Zenodo record.
    
-
    Usage
    
+
    Usage
    
 
    ZenodoManager$discardChanges(recordId)
    
 
    
 
 
    
-
    Arguments
    
+
    Arguments
    
 
    recordId
    
 
    the ID of the record for which changes have to be discarded.
    
 
@@ -879,19 +923,19 @@ 
    Arguments
-
    Returns
    
+
    Returns
    
 
    an object of class ZenodoRecord
    
 
    
 
 
    
 
    Method publishRecord()
    
 
    Publishes a Zenodo record.
    
-
    Usage
    
+
    Usage
    
 
    ZenodoManager$publishRecord(recordId)
    
 
    
 
 
    
-
    Arguments
    
+
    Arguments
    
 
    recordId
    
 
    the ID of the record to be published.
    
 
@@ -899,19 +943,19 @@ 
    Arguments
-
    Returns
    
+
    Returns
    
 
    an object of class ZenodoRecord
    
 
    
 
 
    
 
    Method getFiles()
    
 
    Get list of files attached to a Zenodo record.
    
-
    Usage
    
+
    Usage
    
 
    ZenodoManager$getFiles(recordId)
    
 
    
 
 
    
-
    Arguments
    
+
    Arguments
    
 
    recordId
    
 
    the ID of the record.
    
 
@@ -919,19 +963,19 @@ 
    Arguments
-
    Returns
    
+
    Returns
    
 
    list of files
    
 
    
 
 
    
 
    Method getFile()
    
 
    Get a file record metadata.
    
-
    Usage
    
+
    Usage
    
 
    ZenodoManager$getFile(recordId, filename)
    
 
    
 
 
    
-
    Arguments
    
+
    Arguments
    
 
    recordId
    
 
    the ID of the record.
    
 
@@ -943,7 +987,7 @@ 
    Arguments
-
    Returns
    
+
    Returns
    
 
    the file metadata
    
 
    
 
@@ -952,12 +996,12 @@ 
    Method startFileUpload()
-
    Usage
    
+
    Usage
    
 
    ZenodoManager$startFileUpload(path, recordId)
    
 
    
 
 
    
-
    Arguments
    
+
    Arguments
    
 
    path
    
 
    Local path of the file
    
 
@@ -974,12 +1018,12 @@ 
    Method completeFileUpload()Completes a file upload. The method will complete a file upload through a commit operation
 This method is essentially for internal purpose, and is called directly in uploadFile
 for user convenience and for backward compatibility with the legacy Zenodo API.
    
-
    Usage
    
+
    Usage
    
 
    ZenodoManager$completeFileUpload(path, recordId)
    
 
    
 
 
    
-
    Arguments
    
+
    Arguments
    
 
    path
    
 
    Local path of the file
    
 
@@ -997,12 +1041,12 @@ 
    Method uploadFile()startFileUpload to create a file record (with a filename key) at start, followed
 by the actual file content upload. At this stage, the file upload is in "pending" status. At the end,
 the function calls completeFileUpload to commit the file which status becomes "completed".
    
-
    Usage
    
+
    Usage
    
 
    ZenodoManager$uploadFile(path, recordId = NULL, record = NULL)
    
 
    
 
 
    
-
    Arguments
    
+
    Arguments
    
 
    path
    
 
    Local path of the file
    
 
@@ -1024,12 +1068,12 @@ 
    Method deleteFile()
    
-
    Usage
    
+
    Usage
    
 
    ZenodoManager$deleteFile(recordId, filename)
    
 
    
 
 
    
-
    Arguments
    
+
    Arguments
    
 
    recordId
    
 
    ID of the record
    
 
@@ -1051,12 +1095,12 @@ 
    Method getRecords()exact specifies that an exact matching is wished, in which case 
     paginated search will be disabled (only the first search page will be returned).
     Examples of ElasticSearch queries for Zenodo can be found at https://help.zenodo.org/guides/search/.
    
-
    Usage
    
+
    Usage
    
 
    ZenodoManager$getRecords(q = "", size = 10, all_versions = FALSE, exact = TRUE)
    
 
    
 
 
    
-
    Arguments
    
+
    Arguments
    
 
    q
    
 
    Elastic-Search-compliant query, as object of class character. Default is ""
    
 
@@ -1080,19 +1124,19 @@ 
    Arguments
-
    Returns
    
+
    Returns
    
 
    a list of ZenodoRecord
    
 
    
 
 
    
 
    Method getRecordByConceptDOI()
    
 
    Get Record by concept DOI
    
-
    Usage
    
+
    Usage
    
 
    ZenodoManager$getRecordByConceptDOI(conceptdoi)
    
 
    
 
 
    
-
    Arguments
    
+
    Arguments
    
 
    conceptdoi
    
 
    the concept DOI
    
 
@@ -1100,19 +1144,19 @@ 
    Arguments
-
    Returns
    
+
    Returns
    
 
    a object of class ZenodoRecord
    
 
    
 
 
    
 
    Method getRecordByDOI()
    
 
    Get Record by DOI
    
-
    Usage
    
+
    Usage
    
 
    ZenodoManager$getRecordByDOI(doi)
    
 
    
 
 
    
-
    Arguments
    
+
    Arguments
    
 
    doi
    
 
    the DOI
    
 
@@ -1120,19 +1164,19 @@ 
    Arguments
-
    Returns
    
+
    Returns
    
 
    a object of class ZenodoRecord
    
 
    
 
 
    
 
    Method getRecordById()
    
 
    Get Record by ID
    
-
    Usage
    
+
    Usage
    
 
    ZenodoManager$getRecordById(recid)
    
 
    
 
 
    
-
    Arguments
    
+
    Arguments
    
 
    recid
    
 
    the record ID
    
 
@@ -1140,19 +1184,19 @@ 
    Arguments
-
    Returns
    
+
    Returns
    
 
    a object of class ZenodoRecord
    
 
    
 
 
    
 
    Method getRecordByConceptId()
    
 
    Get Record by concept ID
    
-
    Usage
    
+
    Usage
    
 
    ZenodoManager$getRecordByConceptId(conceptrecid)
    
 
    
 
 
    
-
    Arguments
    
+
    Arguments
    
 
    conceptrecid
    
 
    the concept ID
    
 
@@ -1160,19 +1204,19 @@ 
    Arguments
-
    Returns
    
+
    Returns
    
 
    a object of class ZenodoRecord
    
 
    
 
 
    
 
    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.
    
 
@@ -1203,6 +1247,7 @@ 
    Examples
    
   myrec$setTitle("my R package")
   myrec$setDescription("A description of my R package")
   myrec$setUploadType("software")
+#> [zen4R][WARN] ZenodoRecord - Method 'setUploadType' is deprecated, please use 'setResourceType' 
   myrec$addCreator(
     firstname = "John", lastname = "Doe",
     affiliation = "Independent", orcid = "0000-0000-0000-0000"
diff --git a/reference/ZenodoRecord.html b/reference/ZenodoRecord.html
index 508534f..4d99693 100644
--- a/reference/ZenodoRecord.html
+++ b/reference/ZenodoRecord.html
@@ -173,6 +173,7 @@ 
    Public methods
    ZenodoRecord$getLastDOI()
    
 
  • ZenodoRecord$getVersions()
    • 
 
  • ZenodoRecord$getStats()
    • 
+
  • ZenodoRecord$setResourceType()
    • 
 
  • ZenodoRecord$setUploadType()
    • 
 
  • ZenodoRecord$setPublicationType()
    • 
 
  • ZenodoRecord$setImageType()
    • 
@@ -439,15 +440,31 @@ 
    Returns
    
+
    Method setResourceType()
    
+
    Set the resource type (mandatory).
    
+
    Usage
    
+
    ZenodoRecord$setResourceType(resourceType)
    
+
    
+
+
    
+
    Arguments
    
+
    resourceType
    
+
    record resource type
    
+
+
+
    
+
    
+
 
    
 
    Method setUploadType()
    
-
    Set the upload type (mandatory).
    
-
    Usage
    
+
    Set the upload type (mandatory). Deprecated since zen4R 1.0
    
+
    Usage
    
 
    ZenodoRecord$setUploadType(uploadType)
    
 
    
 
 
    
-
    Arguments
    
+
    Arguments
    
 
    uploadType
    
 
    record upload type among the following values: 'publication', 'poster', 
 'presentation', 'dataset', 'image', 'video', 'software', 'lesson', 'physicalobject', 'other'
    
@@ -458,13 +475,13 @@ 
    Arguments
    
 
    Method setPublicationType()
    
-
    Set the publication type (mandatory if upload type is 'publication').
    
-
    Usage
    
+
    Set the publication type (mandatory if upload type is 'publication'). Deprecated since zen4R 1.0
    
+
    Usage
    
 
    ZenodoRecord$setPublicationType(publicationType)
    
 
    
 
 
    
-
    Arguments
    
+
    Arguments
    
 
    publicationType
    
 
    record publication type among the following values: 'annotationcollection', 'book', 
 'section', 'conferencepaper', 'datamanagementplan', 'article', 'patent', 'preprint', 'deliverable', 'milestone', 
@@ -477,13 +494,13 @@ 
    Arguments
    
 
    Method setImageType()
    
-
    Set the image type (mandatory if image type is 'image').
    
-
    Usage
    
+
    Set the image type (mandatory if image type is 'image'). Deprecated since zen4R 1.0
    
+
    Usage
    
 
    ZenodoRecord$setImageType(imageType)
    
 
    
 
 
    
-
    Arguments
    
+
    Arguments
    
 
    imageType
    
 
    record publication type among the following values: 'figure','plot',
 'drawing','diagram','photo', or 'other'
    
@@ -495,12 +512,12 @@ 
    Arguments
    
 
    Method setPublicationDate()
    
 
    Set the publication date.
    
-
    Usage
    
+
    Usage
    
 
    ZenodoRecord$setPublicationDate(publicationDate)
    
 
    
 
 
    
-
    Arguments
    
+
    Arguments
    
 
    publicationDate
    
 
    object of class Date
    
 
@@ -511,12 +528,12 @@ 
    Arguments
    
 
    Method setEmbargoDate()
    
 
    Set the embargo date.
    
-
    Usage
    
+
    Usage
    
 
    ZenodoRecord$setEmbargoDate(embargoDate)
    
 
    
 
 
    
-
    Arguments
    
+
    Arguments
    
 
    embargoDate
    
 
    object of class Date
    
 
@@ -527,12 +544,12 @@ 
    Arguments
    
 
    Method setTitle()
    
 
    Set the record title.
    
-
    Usage
    
+
    Usage
    
 
    ZenodoRecord$setTitle(title)
    
 
    
 
 
    
-
    Arguments
    
+
    Arguments
    
 
    title
    
 
    object of class character
    
 
@@ -543,12 +560,12 @@ 
    Arguments
    
 
    Method setDescription()
    
 
    Set the record description
    
-
    Usage
    
+
    Usage
    
 
    ZenodoRecord$setDescription(description)
    
 
    
 
 
    
-
    Arguments
    
+
    Arguments
    
 
    description
    
 
    object of class character
    
 
@@ -559,12 +576,12 @@ 
    Arguments
    
 
    Method setAccessRight()
    
 
    Set the access right.
    
-
    Usage
    
+
    Usage
    
 
    ZenodoRecord$setAccessRight(accessRight)
    
 
    
 
 
    
-
    Arguments
    
+
    Arguments
    
 
    accessRight
    
 
    record access right among the following values: 'open','embargoed', 'restricted','closed'
    
 
@@ -575,12 +592,12 @@ 
    Arguments
    
 
    Method setAccessConditions()
    
 
    set the access conditions.
    
-
    Usage
    
+
    Usage
    
 
    ZenodoRecord$setAccessConditions(accessConditions)
    
 
    
 
 
    
-
    Arguments
    
+
    Arguments
    
 
    accessConditions
    
 
    object of class character
    
 
@@ -594,7 +611,7 @@ 
    Method addCreator()lastname arguments, that by default will be concatenated for Zenodo as
    lastname, firstname. For more flexibility over this, the name
    argument can be directly used.
    
-
    Usage
    
+
    Usage
    
 
    ZenodoRecord$addCreator(
   firstname,
   lastname,
@@ -606,7 +623,7 @@ 
    Usage
 
 
    
-
    Arguments
    
+
    Arguments
    
 
    firstname
    
 
    creator first name
    
 
@@ -643,12 +660,12 @@ 
    Method removeCreator()
-
    Usage
    
+
    Usage
    
 
    ZenodoRecord$removeCreator(by, property)
    
 
    
 
 
    
-
    Arguments
    
+
    Arguments
    
 
    by
    
 
    property used as criterion to remove the creator
    
 
@@ -667,12 +684,12 @@ 
    Returns
    
 
    Method removeCreatorByName()
    
 
    Removes a creator by name.
    
-
    Usage
    
+
    Usage
    
 
    ZenodoRecord$removeCreatorByName(name)
    
 
    
 
 
    
-
    Arguments
    
+
    Arguments
    
 
    name
    
 
    creator name
    
 
@@ -687,12 +704,12 @@ 
    Returns
    
 
    Method removeCreatorByAffiliation()
    
 
    Removes a creator by affiliation.
    
-
    Usage
    
+
    Usage
    
 
    ZenodoRecord$removeCreatorByAffiliation(affiliation)
    
 
    
 
 
    
-
    Arguments
    
+
    Arguments
    
 
    affiliation
    
 
    creator affiliation
    
 
@@ -707,12 +724,12 @@ 
    Returns
    
 
    Method removeCreatorByORCID()
    
 
    Removes a creator by ORCID.
    
-
    Usage
    
+
    Usage
    
 
    ZenodoRecord$removeCreatorByORCID(orcid)
    
 
    
 
 
    
-
    Arguments
    
+
    Arguments
    
 
    orcid
    
 
    creator ORCID
    
 
@@ -727,12 +744,12 @@ 
    Returns
    
 
    Method removeCreatorByGND()
    
 
    Removes a creator by GND.
    
-
    Usage
    
+
    Usage
    
 
    ZenodoRecord$removeCreatorByGND(gnd)
    
 
    
 
 
    
-
    Arguments
    
+
    Arguments
    
 
    gnd
    
 
    creator GND
    
 
@@ -750,7 +767,7 @@ 
    Method addContributor()
-
    Usage
    
+
    Usage
    
 
    ZenodoRecord$addContributor(
   firstname,
   lastname,
@@ -763,7 +780,7 @@ 
    Usage
 
 
    
-
    Arguments
    
+
    Arguments
    
 
    firstname
    
 
    contributor first name
    
 
@@ -808,12 +825,12 @@ 
    Method removeContributor()FALSE otherwise.
    
-
    Usage
    
+
    Usage
    
 
    ZenodoRecord$removeContributor(by, property)
    
 
    
 
 
    
-
    Arguments
    
+
    Arguments
    
 
    by
    
 
    property used as criterion to remove the contributor
    
 
@@ -832,12 +849,12 @@ 
    Returns
    
 
    Method removeContributorByName()
    
 
    Removes a contributor by name.
    
-
    Usage
    
+
    Usage
    
 
    ZenodoRecord$removeContributorByName(name)
    
 
    
 
 
    
-
    Arguments
    
+
    Arguments
    
 
    name
    
 
    contributor name
    
 
@@ -852,12 +869,12 @@ 
    Returns
    
 
    Method removeContributorByAffiliation()
    
 
    Removes a contributor by affiliation.
    
-
    Usage
    
+
    Usage
    
 
    ZenodoRecord$removeContributorByAffiliation(affiliation)
    
 
    
 
 
    
-
    Arguments
    
+
    Arguments
    
 
    affiliation
    
 
    contributor affiliation
    
 
@@ -872,12 +889,12 @@ 
    Returns
    
 
    Method removeContributorByORCID()
    
 
    Removes a contributor by ORCID.
    
-
    Usage
    
+
    Usage
    
 
    ZenodoRecord$removeContributorByORCID(orcid)
    
 
    
 
 
    
-
    Arguments
    
+
    Arguments
    
 
    orcid
    
 
    contributor ORCID
    
 
@@ -892,12 +909,12 @@ 
    Returns
    
 
    Method removeContributorByGND()
    
 
    Removes a contributor by GND.
    
-
    Usage
    
+
    Usage
    
 
    ZenodoRecord$removeContributorByGND(gnd)
    
 
    
 
 
    
-
    Arguments
    
+
    Arguments
    
 
    gnd
    
 
    contributor GND
    
 
@@ -914,12 +931,12 @@ 
    Method setLicense()Set license. The license should be set with the Zenodo id of the license. If not
    recognized by Zenodo, the function will return an error. The list of licenses can
    fetched with the ZenodoManager and the function $getLicenses().
    
-
    Usage
    
+
    Usage
    
 
    ZenodoRecord$setLicense(licenseId, sandbox = FALSE)
    
 
    
 
 
    
-
    Arguments
    
+
    Arguments
    
 
    licenseId
    
 
    a license Id
    
 
@@ -934,12 +951,12 @@ 
    Arguments
    
 
    Method setVersion()
    
 
    Set record version.
    
-
    Usage
    
+
    Usage
    
 
    ZenodoRecord$setVersion(version)
    
 
    
 
 
    
-
    Arguments
    
+
    Arguments
    
 
    version
    
 
    the record version to set
    
 
@@ -950,12 +967,12 @@ 
    Arguments
    
 
    Method setLanguage()
    
 
    Set the language.
    
-
    Usage
    
+
    Usage
    
 
    ZenodoRecord$setLanguage(language)
    
 
    
 
 
    
-
    Arguments
    
+
    Arguments
    
 
    language
    
 
    ISO 639-2 or 639-3 code
    
 
@@ -966,12 +983,12 @@ 
    Arguments
    
 
    Method addRelatedIdentifier()
    
 
    Adds a related identifier with a given relation.
    
-
    Usage
    
+
    Usage
    
 
    ZenodoRecord$addRelatedIdentifier(relation, identifier, resource_type = NULL)
    
 
    
 
 
    
-
    Arguments
    
+
    Arguments
    
 
    relation
    
 
    relation type among following values: isCitedBy, cites, isSupplementTo, isSupplementedBy, 
 isContinuedBy, continues, isDescribedBy, describes, hasMetadata, isMetadataFor, isNewVersionOf, 
@@ -995,12 +1012,12 @@ 
    Arguments
    
 
    Method removeRelatedIdentifier()
    
 
    Removes a related identifier with a given relation.
    
-
    Usage
    
+
    Usage
    
 
    ZenodoRecord$removeRelatedIdentifier(relation, identifier)
    
 
    
 
 
    
-
    Arguments
    
+
    Arguments
    
 
    relation
    
 
    relation type among following values: isCitedBy, cites, isSupplementTo, isSupplementedBy, 
 isContinuedBy, continues, isDescribedBy, describes, hasMetadata, isMetadataFor, isNewVersionOf, 
@@ -1019,12 +1036,12 @@ 
    Arguments
    
 
    Method setReferences()
    
 
    Set references
    
-
    Usage
    
+
    Usage
    
 
    ZenodoRecord$setReferences(references)
    
 
    
 
 
    
-
    Arguments
    
+
    Arguments
    
 
    references
    
 
    a vector or list of references to set for the record
    
 
@@ -1035,12 +1052,12 @@ 
    Arguments
    
 
    Method addReference()
    
 
    Add a reference
    
-
    Usage
    
+
    Usage
    
 
    ZenodoRecord$addReference(reference)
    
 
    
 
 
    
-
    Arguments
    
+
    Arguments
    
 
    reference
    
 
    the reference to add
    
 
@@ -1055,12 +1072,12 @@ 
    Returns
    
 
    Method removeReference()
    
 
    Remove a reference
    
-
    Usage
    
+
    Usage
    
 
    ZenodoRecord$removeReference(reference)
    
 
    
 
 
    
-
    Arguments
    
+
    Arguments
    
 
    reference
    
 
    the reference to remove
    
 
@@ -1075,12 +1092,12 @@ 
    Returns
    
 
    Method setKeywords()
    
 
    Set keywords
    
-
    Usage
    
+
    Usage
    
 
    ZenodoRecord$setKeywords(keywords)
    
 
    
 
 
    
-
    Arguments
    
+
    Arguments
    
 
    keywords
    
 
    a vector or list of keywords to set for the record
    
 
@@ -1091,12 +1108,12 @@ 
    Arguments
    
 
    Method addKeyword()
    
 
    Add a keyword
    
-
    Usage
    
+
    Usage
    
 
    ZenodoRecord$addKeyword(keyword)
    
 
    
 
 
    
-
    Arguments
    
+
    Arguments
    
 
    keyword
    
 
    the keyword to add
    
 
@@ -1111,12 +1128,12 @@ 
    Returns
    
 
    Method removeKeyword()
    
 
    Remove a keyword
    
-
    Usage
    
+
    Usage
    
 
    ZenodoRecord$removeKeyword(keyword)
    
 
    
 
 
    
-
    Arguments
    
+
    Arguments
    
 
    keyword
    
 
    the keyword to remove
    
 
@@ -1131,12 +1148,12 @@ 
    Returns
    
 
    Method addSubject()
    
 
    Adds a subject given a term and identifier
    
-
    Usage
    
+
    Usage
    
 
    ZenodoRecord$addSubject(term, identifier)
    
 
    
 
 
    
-
    Arguments
    
+
    Arguments
    
 
    term
    
 
    subject term
    
 
@@ -1152,12 +1169,12 @@ 
    ArgumentsMethod removeSubject()
    
 
    Removes subject(s) by a property. The by parameter should be the name
    of the subject property ('term' or 'identifier').
    
-
    Usage
    
+
    Usage
    
 
    ZenodoRecord$removeSubject(by, property)
    
 
    
 
 
    
-
    Arguments
    
+
    Arguments
    
 
    by
    
 
    property used as criterion to remove subjects
    
 
@@ -1176,12 +1193,12 @@ 
    Returns
    
 
    Method removeSubjectByTerm()
    
 
    Removes subject(s) by term.
    
-
    Usage
    
+
    Usage
    
 
    ZenodoRecord$removeSubjectByTerm(term)
    
 
    
 
 
    
-
    Arguments
    
+
    Arguments
    
 
    term
    
 
    the term to use to remove subject(s)
    
 
@@ -1196,12 +1213,12 @@ 
    Returns
    
 
    Method removeSubjectByIdentifier()
    
 
    Removes subject(s) by identifier
    
-
    Usage
    
+
    Usage
    
 
    ZenodoRecord$removeSubjectByIdentifier(identifier)
    
 
    
 
 
    
-
    Arguments
    
+
    Arguments
    
 
    identifier
    
 
    the identifier to use to remove subject(s)
    
 
@@ -1216,12 +1233,12 @@ 
    Returns
    
 
    Method setNotes()
    
 
    Set notes. HTML is not allowed
    
-
    Usage
    
+
    Usage
    
 
    ZenodoRecord$setNotes(notes)
    
 
    
 
 
    
-
    Arguments
    
+
    Arguments
    
 
    notes
    
 
    object of class character
    
 
@@ -1232,12 +1249,12 @@ 
    Arguments
    
 
    Method setCommunities()
    
 
    Set a vector of character strings identifying communities
    
-
    Usage
    
+
    Usage
    
 
    ZenodoRecord$setCommunities(communities, sandbox = FALSE)
    
 
    
 
 
    
-
    Arguments
    
+
    Arguments
    
 
    communities
    
 
    a vector or list of communities. Values should among known communities. The list of communities can
 fetched with the ZenodoManager and the function $getCommunities(). Each community should be set with 
@@ -1254,12 +1271,12 @@ 
    Arguments
    
 
    Method addCommunity()
    
 
    Adds a community to the record metadata.
    
-
    Usage
    
+
    Usage
    
 
    ZenodoRecord$addCommunity(community, sandbox = FALSE)
    
 
    
 
 
    
-
    Arguments
    
+
    Arguments
    
 
    community
    
 
    community to add. The community should be set with the Zenodo id of the community. 
 If not recognized by Zenodo, the function will return an error. The list of communities can fetched 
@@ -1280,12 +1297,12 @@ 
    Returns
    
 
    Method removeCommunity()
    
 
    Removes a community from the record metadata.
    
-
    Usage
    
+
    Usage
    
 
    ZenodoRecord$removeCommunity(community)
    
 
    
 
 
    
-
    Arguments
    
+
    Arguments
    
 
    community
    
 
    community to remove. The community should be set with the Zenodo id of the community.
    
 
@@ -1300,12 +1317,12 @@ 
    Returns
    
 
    Method setGrants()
    
 
    Set a vector of character strings identifying grants
    
-
    Usage
    
+
    Usage
    
 
    ZenodoRecord$setGrants(grants, sandbox = FALSE)
    
 
    
 
 
    
-
    Arguments
    
+
    Arguments
    
 
    grants
    
 
    a vector or list of grants Values should among known grants The list of grants can
 fetched with the ZenodoManager and the function $getGrants(). Each grant should be set with 
@@ -1322,12 +1339,12 @@ 
    Arguments
    
 
    Method addGrant()
    
 
    Adds a grant to the record metadata.
    
-
    Usage
    
+
    Usage
    
 
    ZenodoRecord$addGrant(grant, sandbox = FALSE)
    
 
    
 
 
    
-
    Arguments
    
+
    Arguments
    
 
    grant
    
 
    grant to add. The grant should be set with the id of the grant. If not
 recognized by Zenodo, the function will return an warning only. The list of grants can
@@ -1348,12 +1365,12 @@ 
    Returns
    
 
    Method removeGrant()
    
 
    Removes a grant from the record metadata.
    
-
    Usage
    
+
    Usage
    
 
    ZenodoRecord$removeGrant(grant)
    
 
    
 
 
    
-
    Arguments
    
+
    Arguments
    
 
    grant
    
 
    grant to remove. The grant should be set with the Zenodo id of the grant
    
 
@@ -1368,12 +1385,12 @@ 
    Returns
    
 
    Method setJournalTitle()
    
 
    Set Journal title to the record metadata
    
-
    Usage
    
+
    Usage
    
 
    ZenodoRecord$setJournalTitle(title)
    
 
    
 
 
    
-
    Arguments
    
+
    Arguments
    
 
    title
    
 
    a title, object of class character
    
 
@@ -1384,12 +1401,12 @@ 
    Arguments
    
 
    Method setJournalVolume()
    
 
    Set Journal volume to the record metadata
    
-
    Usage
    
+
    Usage
    
 
    ZenodoRecord$setJournalVolume(volume)
    
 
    
 
 
    
-
    Arguments
    
+
    Arguments
    
 
    volume
    
 
    a volume
    
 
@@ -1400,12 +1417,12 @@ 
    Arguments
    
 
    Method setJournalIssue()
    
 
    Set Journal issue to the record metadata
    
-
    Usage
    
+
    Usage
    
 
    ZenodoRecord$setJournalIssue(issue)
    
 
    
 
 
    
-
    Arguments
    
+
    Arguments
    
 
    issue
    
 
    an issue
    
 
@@ -1416,12 +1433,12 @@ 
    Arguments
    
 
    Method setJournalPages()
    
 
    Set Journal pages to the record metadata
    
-
    Usage
    
+
    Usage
    
 
    ZenodoRecord$setJournalPages(pages)
    
 
    
 
 
    
-
    Arguments
    
+
    Arguments
    
 
    pages
    
 
    number of pages
    
 
@@ -1432,12 +1449,12 @@ 
    Arguments
    
 
    Method setConferenceTitle()
    
 
    Set conference title to the record metadata
    
-
    Usage
    
+
    Usage
    
 
    ZenodoRecord$setConferenceTitle(title)
    
 
    
 
 
    
-
    Arguments
    
+
    Arguments
    
 
    title
    
 
    conference title, object of class character
    
 
@@ -1448,12 +1465,12 @@ 
    Arguments
    
 
    Method setConferenceAcronym()
    
 
    Set conference acronym to the record metadata
    
-
    Usage
    
+
    Usage
    
 
    ZenodoRecord$setConferenceAcronym(acronym)
    
 
    
 
 
    
-
    Arguments
    
+
    Arguments
    
 
    acronym
    
 
    conference acronym, object of class character
    
 
@@ -1464,12 +1481,12 @@ 
    Arguments
    
 
    Method setConferenceDates()
    
 
    Set conference dates to the record metadata
    
-
    Usage
    
+
    Usage
    
 
    ZenodoRecord$setConferenceDates(dates)
    
 
    
 
 
    
-
    Arguments
    
+
    Arguments
    
 
    dates
    
 
    conference dates, object of class character
    
 
@@ -1480,12 +1497,12 @@ 
    Arguments
    
 
    Method setConferencePlace()
    
 
    Set conference place to the record metadata
    
-
    Usage
    
+
    Usage
    
 
    ZenodoRecord$setConferencePlace(place)
    
 
    
 
 
    
-
    Arguments
    
+
    Arguments
    
 
    place
    
 
    conference place, object of class character
    
 
@@ -1496,12 +1513,12 @@ 
    Arguments
    
 
    Method setConferenceUrl()
    
 
    Set conference url to the record metadata
    
-
    Usage
    
+
    Usage
    
 
    ZenodoRecord$setConferenceUrl(url)
    
 
    
 
 
    
-
    Arguments
    
+
    Arguments
    
 
    url
    
 
    conference url, object of class character
    
 
@@ -1512,12 +1529,12 @@ 
    Arguments
    
 
    Method setConferenceSession()
    
 
    Set conference session to the record metadata
    
-
    Usage
    
+
    Usage
    
 
    ZenodoRecord$setConferenceSession(session)
    
 
    
 
 
    
-
    Arguments
    
+
    Arguments
    
 
    session
    
 
    conference session, object of class character
    
 
@@ -1528,12 +1545,12 @@ 
    Arguments
    
 
    Method setConferenceSessionPart()
    
 
    Set conference session part to the record metadata
    
-
    Usage
    
+
    Usage
    
 
    ZenodoRecord$setConferenceSessionPart(part)
    
 
    
 
 
    
-
    Arguments
    
+
    Arguments
    
 
    part
    
 
    conference session part, object of class character
    
 
@@ -1544,12 +1561,12 @@ 
    Arguments
    
 
    Method setImprintPublisher()
    
 
    Set imprint publisher to the record metadata
    
-
    Usage
    
+
    Usage
    
 
    ZenodoRecord$setImprintPublisher(publisher)
    
 
    
 
 
    
-
    Arguments
    
+
    Arguments
    
 
    publisher
    
 
    the publisher, object of class character
    
 
@@ -1560,12 +1577,12 @@ 
    Arguments
    
 
    Method setImprintISBN()
    
 
    Set imprint ISBN to the record metadata
    
-
    Usage
    
+
    Usage
    
 
    ZenodoRecord$setImprintISBN(isbn)
    
 
    
 
 
    
-
    Arguments
    
+
    Arguments
    
 
    isbn
    
 
    the ISBN, object of class character
    
 
@@ -1576,12 +1593,12 @@ 
    Arguments
    
 
    Method setImprintPlace()
    
 
    Set imprint place to the record metadata
    
-
    Usage
    
+
    Usage
    
 
    ZenodoRecord$setImprintPlace(place)
    
 
    
 
 
    
-
    Arguments
    
+
    Arguments
    
 
    place
    
 
    the place, object of class character
    
 
@@ -1592,12 +1609,12 @@ 
    Arguments
    
 
    Method setPartofTitle()
    
 
    Set title to which record is part of
    
-
    Usage
    
+
    Usage
    
 
    ZenodoRecord$setPartofTitle(title)
    
 
    
 
 
    
-
    Arguments
    
+
    Arguments
    
 
    title
    
 
    the title, object of class character
    
 
@@ -1608,12 +1625,12 @@ 
    Arguments
    
 
    Method setPartofPages()
    
 
    Set pages to which record is part of
    
-
    Usage
    
+
    Usage
    
 
    ZenodoRecord$setPartofPages(pages)
    
 
    
 
 
    
-
    Arguments
    
+
    Arguments
    
 
    pages
    
 
    the pages, object of class character
    
 
@@ -1624,12 +1641,12 @@ 
    Arguments
    
 
    Method setThesisUniversity()
    
 
    Set thesis university
    
-
    Usage
    
+
    Usage
    
 
    ZenodoRecord$setThesisUniversity(university)
    
 
    
 
 
    
-
    Arguments
    
+
    Arguments
    
 
    university
    
 
    the university, object of class character
    
 
@@ -1640,7 +1657,7 @@ 
    Arguments
    
 
    Method addThesisSupervisor()
    
 
    Adds thesis supervisor
    
-
    Usage
    
+
    Usage
    
 
    ZenodoRecord$addThesisSupervisor(
   firstname,
   lastname,
@@ -1651,7 +1668,7 @@ 
    Usage
 
 
    
-
    Arguments
    
+
    Arguments
    
 
    firstname
    
 
    supervisor first name
    
 
@@ -1680,12 +1697,12 @@ 
    Method removeThesisSupervisor()Removes a thesis supervisor by a property. The by parameter should be the name
    of the thesis supervisor property ('name' - in the form 'lastname, firstname', 'affiliation',
    'orcid' or 'gnd').
    
-
    Usage
    
+
    Usage
    
 
    ZenodoRecord$removeThesisSupervisor(by, property)
    
 
    
 
 
    
-
    Arguments
    
+
    Arguments
    
 
    by
    
 
    property used as criterion to remove the thesis supervisor
    
 
@@ -1704,12 +1721,12 @@ 
    Returns
    
 
    Method removeThesisSupervisorByName()
    
 
    Removes a thesis supervisor by name.
    
-
    Usage
    
+
    Usage
    
 
    ZenodoRecord$removeThesisSupervisorByName(name)
    
 
    
 
 
    
-
    Arguments
    
+
    Arguments
    
 
    name
    
 
    thesis supervisor name
    
 
@@ -1724,12 +1741,12 @@ 
    Returns
    
 
    Method removeThesisSupervisorByAffiliation()
    
 
    Removes a thesis supervisor by affiliation
    
-
    Usage
    
+
    Usage
    
 
    ZenodoRecord$removeThesisSupervisorByAffiliation(affiliation)
    
 
    
 
 
    
-
    Arguments
    
+
    Arguments
    
 
    affiliation
    
 
    thesis supervisor affiliation
    
 
@@ -1744,12 +1761,12 @@ 
    Returns
    
 
    Method removeThesisSupervisorByORCID()
    
 
    Removes a thesis supervisor by ORCID
    
-
    Usage
    
+
    Usage
    
 
    ZenodoRecord$removeThesisSupervisorByORCID(orcid)
    
 
    
 
 
    
-
    Arguments
    
+
    Arguments
    
 
    orcid
    
 
    thesis supervisor ORCID
    
 
@@ -1764,12 +1781,12 @@ 
    Returns
    
 
    Method removeThesisSupervisorByGND()
    
 
    Removes a thesis supervisor by GND
    
-
    Usage
    
+
    Usage
    
 
    ZenodoRecord$removeThesisSupervisorByGND(gnd)
    
 
    
 
 
    
-
    Arguments
    
+
    Arguments
    
 
    gnd
    
 
    thesis supervisor GND
    
 
@@ -1784,12 +1801,12 @@ 
    Returns
    
 
    Method addLocation()
    
 
    Adds a location to the record metadata.
    
-
    Usage
    
+
    Usage
    
 
    ZenodoRecord$addLocation(place, description = NULL, lat = NULL, lon = NULL)
    
 
    
 
 
    
-
    Arguments
    
+
    Arguments
    
 
    place
    
 
    place (required)
    
 
@@ -1812,12 +1829,12 @@ 
    Arguments
    
 
    Method removeLocation()
    
 
    Removes a grant from the record metadata.
    
-
    Usage
    
+
    Usage
    
 
    ZenodoRecord$removeLocation(place)
    
 
    
 
 
    
-
    Arguments
    
+
    Arguments
    
 
    place
    
 
    place (required)
    
 
@@ -1832,12 +1849,12 @@ 
    Returns
    
 
    Method exportAs()
    
 
    Exports record to a file by format.
    
-
    Usage
    
+
    Usage
    
 
    ZenodoRecord$exportAs(format, filename, append_format = TRUE)
    
 
    
 
 
    
-
    Arguments
    
+
    Arguments
    
 
    format
    
 
    the export format to use. Possibles values are: BibTeX, CSL, DataCite, DublinCore, DCAT, 
 JSON, JSON-LD, GeoJSON, MARCXML
    
@@ -1862,12 +1879,12 @@ 
    Returns
    
 
    Method exportAsBibTeX()
    
 
    Exports record as BibTeX
    
-
    Usage
    
+
    Usage
    
 
    ZenodoRecord$exportAsBibTeX(filename)
    
 
    
 
 
    
-
    Arguments
    
+
    Arguments
    
 
    filename
    
 
    the target filename (without extension)
    
 
@@ -1882,12 +1899,12 @@ 
    Returns
    
 
    Method exportAsCSL()
    
 
    Exports record as CSL
    
-
    Usage
    
+
    Usage
    
 
    ZenodoRecord$exportAsCSL(filename)
    
 
    
 
 
    
-
    Arguments
    
+
    Arguments
    
 
    filename
    
 
    the target filename (without extension)
    
 
@@ -1902,12 +1919,12 @@ 
    Returns
    
 
    Method exportAsDataCite()
    
 
    Exports record as DataCite
    
-
    Usage
    
+
    Usage
    
 
    ZenodoRecord$exportAsDataCite(filename)
    
 
    
 
 
    
-
    Arguments
    
+
    Arguments
    
 
    filename
    
 
    the target filename (without extension)
    
 
@@ -1922,12 +1939,12 @@ 
    Returns
    
 
    Method exportAsDublinCore()
    
 
    Exports record as DublinCore
    
-
    Usage
    
+
    Usage
    
 
    ZenodoRecord$exportAsDublinCore(filename)
    
 
    
 
 
    
-
    Arguments
    
+
    Arguments
    
 
    filename
    
 
    the target filename (without extension)
    
 
@@ -1942,12 +1959,12 @@ 
    Returns
    
 
    Method exportAsDCAT()
    
 
    Exports record as DCAT
    
-
    Usage
    
+
    Usage
    
 
    ZenodoRecord$exportAsDCAT(filename)
    
 
    
 
 
    
-
    Arguments
    
+
    Arguments
    
 
    filename
    
 
    the target filename (without extension)
    
 
@@ -1962,12 +1979,12 @@ 
    Returns
    
 
    Method exportAsJSON()
    
 
    Exports record as JSON
    
-
    Usage
    
+
    Usage
    
 
    ZenodoRecord$exportAsJSON(filename)
    
 
    
 
 
    
-
    Arguments
    
+
    Arguments
    
 
    filename
    
 
    the target filename (without extension)
    
 
@@ -1982,12 +1999,12 @@ 
    Returns
    
 
    Method exportAsJSONLD()
    
 
    Exports record as JSONLD
    
-
    Usage
    
+
    Usage
    
 
    ZenodoRecord$exportAsJSONLD(filename)
    
 
    
 
 
    
-
    Arguments
    
+
    Arguments
    
 
    filename
    
 
    the target filename (without extension)
    
 
@@ -1998,12 +2015,12 @@ 
    Arguments
    
 
    Method exportAsGeoJSON()
    
 
    Exports record as GeoJSON
    
-
    Usage
    
+
    Usage
    
 
    ZenodoRecord$exportAsGeoJSON(filename)
    
 
    
 
 
    
-
    Arguments
    
+
    Arguments
    
 
    filename
    
 
    the target filename (without extension)
    
 
@@ -2018,12 +2035,12 @@ 
    Returns
    
 
    Method exportAsMARCXML()
    
 
    Exports record as MARCXML
    
-
    Usage
    
+
    Usage
    
 
    ZenodoRecord$exportAsMARCXML(filename)
    
 
    
 
 
    
-
    Arguments
    
+
    Arguments
    
 
    filename
    
 
    the target filename (without extension)
    
 
@@ -2039,12 +2056,12 @@ 
    ReturnsMethod exportAsAllFormats()
    
 
    Exports record in all Zenodo record export formats. This function will
    create one file per Zenodo metadata formats.
    
-
    Usage
    
+
    Usage
    
 
    ZenodoRecord$exportAsAllFormats(filename)
    
 
    
 
 
    
-
    Arguments
    
+
    Arguments
    
 
    filename
    
 
    the target filename (without extension)
    
 
@@ -2055,12 +2072,12 @@ 
    Arguments
    
 
    Method listFiles()
    
 
    list files attached to the record
    
-
    Usage
    
+
    Usage
    
 
    ZenodoRecord$listFiles(pretty = TRUE)
    
 
    
 
 
    
-
    Arguments
    
+
    Arguments
    
 
    pretty
    
 
    whether a pretty output (data.frame) should be returned (default TRUE), otherwise
 the raw list of files is returned.
    
@@ -2076,7 +2093,7 @@ 
    Returns
    
 
    Method downloadFiles()
    
 
    Downloads files attached to the record
    
-
    Usage
    
+
    Usage
    
 
    ZenodoRecord$downloadFiles(
   path = ".",
   files = list(),
@@ -2091,7 +2108,7 @@ 
    Usage
 
 
    
-
    Arguments
    
+
    Arguments
    
 
    path
    
 
    target download path (by default it will be the current working directory)
    
 
@@ -2138,12 +2155,12 @@ 
    Arguments
    
 
    Method print()
    
 
    Prints a ZenodoRecord
    
-
    Usage
    
+
    Usage
    
 
    ZenodoRecord$print(..., format = "internal", depth = 1)
    
 
    
 
 
    
-
    Arguments
    
+
    Arguments
    
 
    ...
    
 
    any other parameter. Not used
    
 
@@ -2165,7 +2182,7 @@ 
    Arguments
    
 
    Method toDCEntry()
    
 
    Maps to an atom4R DCEntry. Note: applies only to published records.
    
-
    Usage
    
+
    Usage
    
 
    ZenodoRecord$toDCEntry()
    
 
    
 
@@ -2177,12 +2194,12 @@ 
    Returns
    
 
    Method clone()
    
 
    The objects of this class are cloneable with this method.
    
-
    Usage
    
+
    Usage
    
 
    ZenodoRecord$clone(deep = FALSE)
    
 
    
 
 
    
-
    Arguments
    
+
    Arguments
    
 
    deep
    
 
    Whether to make a deep clone.
    
 
diff --git a/reference/download_zenodo.html b/reference/download_zenodo.html
index 823a92c..36fc62d 100644
--- a/reference/download_zenodo.html
+++ b/reference/download_zenodo.html
@@ -113,8 +113,8 @@ 
    Examples
    
 #> ✔ Successfully fetched published record for concept DOI '10.5281/zenodo.2547036'!
 #> ℹ Download in sequential mode
 #> [zen4R][INFO] ZenodoRecord - Download in sequential mode 
-#> ℹ Will download 2 files from record '6656251' (doi: '10.5281/zenodo.6656251') - total size: 114.5 KiB
-#> [zen4R][INFO] ZenodoRecord - Will download 2 files from record '6656251' (doi: '10.5281/zenodo.6656251') - total size: 114.5 KiB 
+#> ℹ Will download 2 files from record '7552287' (doi: '10.5281/zenodo.7552287') - total size: 119.4 KiB
+#> [zen4R][INFO] ZenodoRecord - Will download 2 files from record '7552287' (doi: '10.5281/zenodo.7552287') - total size: 119.4 KiB 
 #> Error in FUN(X[[i]], ...): object 'infoMSg' not found
  
  library(parallel)
@@ -133,8 +133,8 @@ 
    Examples
    
 #> [zen4R][INFO] ZenodoRecord - Download in parallel mode 
 #> ℹ Using cluster-based parallel handler (cluster 'cl' argument specified)
 #> [zen4R][INFO] ZenodoRecord - Using cluster-based parallel handler (cluster 'cl' argument specified) 
-#> ℹ Will download 2 files from record '6656251' (doi: '10.5281/zenodo.6656251') - total size: 114.5 KiB
-#> [zen4R][INFO] ZenodoRecord - Will download 2 files from record '6656251' (doi: '10.5281/zenodo.6656251') - total size: 114.5 KiB 
+#> ℹ Will download 2 files from record '7552287' (doi: '10.5281/zenodo.7552287') - total size: 119.4 KiB
+#> [zen4R][INFO] ZenodoRecord - Will download 2 files from record '7552287' (doi: '10.5281/zenodo.7552287') - total size: 119.4 KiB 
 #> Error in checkForRemoteErrors(val): 2 nodes produced errors; first error: object 'infoMSg' not found
  
  #download files as parallel using mclapply (for Unix systems)
@@ -152,8 +152,8 @@ 
    Examples
    
 #> [zen4R][INFO] ZenodoRecord - Download in parallel mode 
 #> ℹ Using non cluster-based (no cluster 'cl' argument specified)
 #> [zen4R][INFO] ZenodoRecord - Using non cluster-based (no cluster 'cl' argument specified) 
-#> ℹ Will download 2 files from record '6656251' (doi: '10.5281/zenodo.6656251') - total size: 114.5 KiB
-#> [zen4R][INFO] ZenodoRecord - Will download 2 files from record '6656251' (doi: '10.5281/zenodo.6656251') - total size: 114.5 KiB 
+#> ℹ Will download 2 files from record '7552287' (doi: '10.5281/zenodo.7552287') - total size: 119.4 KiB
+#> [zen4R][INFO] ZenodoRecord - Will download 2 files from record '7552287' (doi: '10.5281/zenodo.7552287') - total size: 119.4 KiB 
 #> Warning: all scheduled cores encountered errors in user code
 #> ℹ Files downloaded at '/home/runner/work/zen4R/zen4R/docs/reference'.
 #> [zen4R][INFO] Files downloaded at '/home/runner/work/zen4R/zen4R/docs/reference'.
diff --git a/reference/get_versions.html b/reference/get_versions.html
index e08a8bf..e6dc8ab 100644
--- a/reference/get_versions.html
+++ b/reference/get_versions.html
@@ -92,17 +92,17 @@ 
    Examples
    
 #> ✔ Successfully fetched published record for concept DOI '10.5281/zenodo.2547036'!
 #> ℹ Successfully fetched list of published records - page 1
 #> ✔ Successfully fetched list of published records!
-#>                created       date  version                    doi
-#> 1  2019-01-22 22:44:30 2019-01-22 0.1-beta 10.5281/zenodo.2547037
-#> 2  2019-06-04 12:47:55 2019-06-03      0.1 10.5281/zenodo.3238351
-#> 3  2019-08-02 08:38:03 2019-08-02      0.2 10.5281/zenodo.3358590
-#> 4  2019-08-27 12:07:00 2019-08-27      0.3 10.5281/zenodo.3378733
-#> 5  2020-09-02 08:48:36 2020-09-02      0.4 10.5281/zenodo.4011667
-#> 6  2021-09-15 12:58:02 2021-09-15      0.5 10.5281/zenodo.5509954
-#> 7  2021-11-30 07:59:59 2021-11-30    0.5-2 10.5281/zenodo.5741143
-#> 8  2022-06-17 11:23:00 2022-06-17    0.6-1 10.5281/zenodo.6656251
-#> 9  2023-01-19 18:44:58 2023-01-19      0.8 10.5281/zenodo.7552287
-#> 10 2023-09-21 06:51:58 2023-09-20      0.9 10.5281/zenodo.8365600
+#>                created       date version                    doi
+#> 1  2020-09-07 06:23:18 2020-09-04   0.4-2 10.5281/zenodo.4017156
+#> 2  2021-10-29 17:40:04 2021-10-29   0.5-1 10.5281/zenodo.5619381
+#> 3  2021-11-30 07:59:59 2021-11-30   0.5-2 10.5281/zenodo.5741143
+#> 4  2022-02-16 16:33:18 2022-02-16   0.5-3 10.5281/zenodo.6109137
+#> 5  2022-05-01 14:35:42 2022-05-01     0.6 10.5281/zenodo.6509945
+#> 6  2022-06-17 11:23:00 2022-06-17   0.6-1 10.5281/zenodo.6656251
+#> 7  2022-08-19 08:03:38 2022-08-19     0.7 10.5281/zenodo.7009208
+#> 8  2023-01-09 23:10:23 2023-01-09   0.7-1 10.5281/zenodo.7517728
+#> 9  2023-01-19 18:44:58 2023-01-19     0.8 10.5281/zenodo.7552287
+#> 10 2023-09-21 06:51:58 2023-09-20     0.9 10.5281/zenodo.8365600
 # }
                 
 
    
diff --git a/reference/get_zenodo.html b/reference/get_zenodo.html
index 01a2112..df21f0a 100644
--- a/reference/get_zenodo.html
+++ b/reference/get_zenodo.html
@@ -101,59 +101,59 @@ 
    Examples
    
 #> ....|-- access: <NULL>
 #> ....|-- conceptdoi: 10.5281/zenodo.2547036
 #> ....|-- conceptrecid: 2547036
-#> ....|-- created: 2022-06-17T11:23:00.916079+00:00
-#> ....|-- doi: 10.5281/zenodo.6656251
-#> ....|-- doi_url: https://doi.org/10.5281/zenodo.6656251
+#> ....|-- created: 2023-01-19T18:44:58.394479+00:00
+#> ....|-- doi: 10.5281/zenodo.7552287
+#> ....|-- doi_url: https://doi.org/10.5281/zenodo.7552287
 #> ....|-- files: 
 #> ........1.
-#> ........|-- filename: zen4R-0.6-1.tar.gz
-#> ........|-- filesize: 51648
-#> ........|-- checksum: a7cf6c5a9bda54867ea3bcab2a5dfdf9
-#> ........|-- download: https://zenodo.org/api/records/6656251/files/zen4R-0.6-1.tar.gz/content
+#> ........|-- filename: zen4R-0.8.zip
+#> ........|-- filesize: 67831
+#> ........|-- checksum: 6509a2007367b5511217005a0bcb29e7
+#> ........|-- download: https://zenodo.org/api/records/7552287/files/zen4R-0.8.zip/content
 #> ........2.
-#> ........|-- filename: zen4R-0.6-1.zip
-#> ........|-- filesize: 65566
-#> ........|-- checksum: 0cd3611a83c51e9c23703bd27e1beb92
-#> ........|-- download: https://zenodo.org/api/records/6656251/files/zen4R-0.6-1.zip/content
-#> ....|-- id: 6656251
+#> ........|-- filename: zen4R-0.8.tar.gz
+#> ........|-- filesize: 54406
+#> ........|-- checksum: 1260501d1b0df748f81b9fc79ec44e2f
+#> ........|-- download: https://zenodo.org/api/records/7552287/files/zen4R-0.8.tar.gz/content
+#> ....|-- id: 7552287
 #> ....|-- links: 
-#> ........|-- self: https://zenodo.org/api/records/6656251
-#> ........|-- self_html: https://zenodo.org/records/6656251
-#> ........|-- self_doi: https://zenodo.org/doi/10.5281/zenodo.6656251
-#> ........|-- doi: https://doi.org/10.5281/zenodo.6656251
+#> ........|-- self: https://zenodo.org/api/records/7552287
+#> ........|-- self_html: https://zenodo.org/records/7552287
+#> ........|-- self_doi: https://zenodo.org/doi/10.5281/zenodo.7552287
+#> ........|-- doi: https://doi.org/10.5281/zenodo.7552287
 #> ........|-- parent: https://zenodo.org/api/records/2547036
 #> ........|-- parent_html: https://zenodo.org/records/2547036
 #> ........|-- parent_doi: https://zenodo.org/doi/10.5281/zenodo.2547036
-#> ........|-- self_iiif_manifest: https://zenodo.org/api/iiif/record:6656251/manifest
-#> ........|-- self_iiif_sequence: https://zenodo.org/api/iiif/record:6656251/sequence/default
-#> ........|-- files: https://zenodo.org/api/records/6656251/files
-#> ........|-- media_files: https://zenodo.org/api/records/6656251/media-files
-#> ........|-- archive: https://zenodo.org/api/records/6656251/files-archive
-#> ........|-- archive_media: https://zenodo.org/api/records/6656251/media-files-archive
-#> ........|-- latest: https://zenodo.org/api/records/6656251/versions/latest
-#> ........|-- latest_html: https://zenodo.org/records/6656251/latest
-#> ........|-- draft: https://zenodo.org/api/records/6656251/draft
-#> ........|-- versions: https://zenodo.org/api/records/6656251/versions
-#> ........|-- access_links: https://zenodo.org/api/records/6656251/access/links
-#> ........|-- access_users: https://zenodo.org/api/records/6656251/access/users
-#> ........|-- access_request: https://zenodo.org/api/records/6656251/access/request
-#> ........|-- access: https://zenodo.org/api/records/6656251/access
-#> ........|-- reserve_doi: https://zenodo.org/api/records/6656251/draft/pids/doi
-#> ........|-- communities: https://zenodo.org/api/records/6656251/communities
-#> ........|-- communities-suggestions: https://zenodo.org/api/records/6656251/communities-suggestions
-#> ........|-- requests: https://zenodo.org/api/records/6656251/requests
+#> ........|-- self_iiif_manifest: https://zenodo.org/api/iiif/record:7552287/manifest
+#> ........|-- self_iiif_sequence: https://zenodo.org/api/iiif/record:7552287/sequence/default
+#> ........|-- files: https://zenodo.org/api/records/7552287/files
+#> ........|-- media_files: https://zenodo.org/api/records/7552287/media-files
+#> ........|-- archive: https://zenodo.org/api/records/7552287/files-archive
+#> ........|-- archive_media: https://zenodo.org/api/records/7552287/media-files-archive
+#> ........|-- latest: https://zenodo.org/api/records/7552287/versions/latest
+#> ........|-- latest_html: https://zenodo.org/records/7552287/latest
+#> ........|-- draft: https://zenodo.org/api/records/7552287/draft
+#> ........|-- versions: https://zenodo.org/api/records/7552287/versions
+#> ........|-- access_links: https://zenodo.org/api/records/7552287/access/links
+#> ........|-- access_users: https://zenodo.org/api/records/7552287/access/users
+#> ........|-- access_request: https://zenodo.org/api/records/7552287/access/request
+#> ........|-- access: https://zenodo.org/api/records/7552287/access
+#> ........|-- reserve_doi: https://zenodo.org/api/records/7552287/draft/pids/doi
+#> ........|-- communities: https://zenodo.org/api/records/7552287/communities
+#> ........|-- communities-suggestions: https://zenodo.org/api/records/7552287/communities-suggestions
+#> ........|-- requests: https://zenodo.org/api/records/7552287/requests
 #> ....|-- metadata: 
 #> ........|-- title: zen4R: R Interface to Zenodo REST API
-#> ........|-- doi: 10.5281/zenodo.6656251
-#> ........|-- publication_date: 2022-06-17
+#> ........|-- doi: 10.5281/zenodo.7552287
+#> ........|-- publication_date: 2023-01-19
 #> ........|-- description: <p>zen4R: R Interface to Zenodo REST API</p>
 #> 
-#> <p><a href="https://github.com/eblondel/zen4R/releases/tag/v0.6-1">https://github.com/eblondel/zen4R/releases/tag/v0.6-1</a></p>
+#> <p><a href="https://github.com/eblondel/zen4R/releases/tag/v0.8">https://github.com/eblondel/zen4R/releases/tag/v0.8</a></p>
 #> ........|-- access_right: open
 #> ........|-- creators: 
 #> ........|-- contributors: 
 #> ........|-- keywords: 
-#> ........|-- version: 0.6-1
+#> ........|-- version: 0.8
 #> ........|-- language: eng
 #> ........|-- resource_type: 
 #> ............|-- title: Software
@@ -163,26 +163,26 @@ 
    Examples
    
 #> ........|-- grants: 
 #> ........|-- communities: 
 #> ........|-- relations: 
-#> ............|-- version: list(index = 12, is_last = FALSE, parent = list(pid_type = "recid", pid_value = "2547036"))
+#> ............|-- version: list(index = 15, is_last = FALSE, parent = list(pid_type = "recid", pid_value = "2547036"))
 #> ........|-- notes: Sponsors: IRD
-#> ....|-- modified: 2023-09-21T06:53:03.924722+00:00
+#> ....|-- modified: 2023-09-21T06:53:04.352509+00:00
 #> ....|-- owners: 
 #> ........1.
 #> ........|-- id: 5183
-#> ....|-- recid: 6656251
+#> ....|-- recid: 7552287
 #> ....|-- status: published
 #> ....|-- state: done
 #> ....|-- submitted: TRUE
-#> ....|-- revision: 7
+#> ....|-- revision: 4
 #> ....|-- stats:
 #>     ↓ downloads = 1195
 #>     ↓ unique_downloads = 453
-#>     ↓ version_downloads = 41
-#>     ↓ version_unique_downloads = 12
+#>     ↓ version_downloads = 7
+#>     ↓ version_unique_downloads = 6
 #>     👁 views = 1461
 #>     👁 unique_views = 1299
-#>     👁 version_unique_views = 96
-#>     👁 version_views = 98
+#>     👁 version_unique_views = 134
+#>     👁 version_views = 138
 # }
                 
 
    
diff --git a/reference/test.bib b/reference/test.bib
index 0830046..74a9f2e 100644
--- a/reference/test.bib
+++ b/reference/test.bib
@@ -1,11 +1,11 @@
-@software{blondel_2022_6656251,
+@software{blondel_2023_7552287,
   author       = {Blondel, Emmanuel and
                   Barde, Julien},
   title        = {zen4R: R Interface to Zenodo REST API},
-  month        = jun,
-  year         = 2022,
+  month        = jan,
+  year         = 2023,
   publisher    = {Zenodo},
-  version      = {0.6-1},
-  doi          = {10.5281/zenodo.6656251},
-  url          = {https://doi.org/10.5281/zenodo.6656251}
+  version      = {0.8},
+  doi          = {10.5281/zenodo.7552287},
+  url          = {https://doi.org/10.5281/zenodo.7552287}
 }
\ No newline at end of file