From 8b6717cd563e60a936198f24235af5f06a7283a5 Mon Sep 17 00:00:00 2001 From: eblondel Date: Tue, 4 Jun 2024 23:10:30 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20eblondel?= =?UTF-8?q?/zen4R@a5642d8cc85d120a99c3bad4c5aa80efc5cd9516=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- pkgdown.yml | 2 +- reference/ZenodoRecord.html | 217 ++++++++++++++++++++---------------- reference/get_zenodo.html | 16 +-- 3 files changed, 130 insertions(+), 105 deletions(-) diff --git a/pkgdown.yml b/pkgdown.yml index dd4cdad..7275461 100644 --- a/pkgdown.yml +++ b/pkgdown.yml @@ -3,5 +3,5 @@ pkgdown: 2.0.9 pkgdown_sha: ~ articles: zen4R: zen4R.html -last_built: 2024-06-03T11:13Z +last_built: 2024-06-04T23:09Z diff --git a/reference/ZenodoRecord.html b/reference/ZenodoRecord.html index 4c649ae..a829e57 100644 --- a/reference/ZenodoRecord.html +++ b/reference/ZenodoRecord.html @@ -210,8 +210,9 @@

Public methods

ZenodoRecord$removeSubject()

  • ZenodoRecord$removeKeyword()

  • ZenodoRecord$setNotes()

    • -

  • ZenodoRecord$setGrants()

    • +

  • ZenodoRecord$addFunding()

  • ZenodoRecord$addGrant()

    • +

  • ZenodoRecord$setGrants()

  • ZenodoRecord$removeGrant()

  • ZenodoRecord$setJournalTitle()

  • ZenodoRecord$setJournalVolume()

    • @@ -1588,19 +1589,21 @@

    Arguments
    -

    Method setGrants()

    -

    Set a vector of character strings identifying grants

    +

    +

    Method addFunding()

    +

    Adds funding. Used internally, prefer using addGrant instead.

    Usage

    -

    ZenodoRecord$setGrants(grants, sandbox = FALSE)

    +

    ZenodoRecord$addFunding(funder = NULL, grant = NULL, sandbox = FALSE)

    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 -the Zenodo id of the grant If not recognized by Zenodo, the function will raise a warning only.

    +

    funder
    +

    funder id or name

    + + +
    grant
    +

    grant id or title

    sandbox
    @@ -1622,7 +1625,7 @@

    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 -fetched with the ZenodoManager and the function $getGrants().

    +fetched with the ZenodoManager and the function $getAwards().

    sandbox
    @@ -1636,15 +1639,37 @@

    Returns
    +

    Method setGrants()

    +

    Set a vector of character strings identifying grants

    +

    Usage

    +

    ZenodoRecord$setGrants(grants, sandbox = FALSE)

    +
    + +
    +

    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 $getAwards(). Each grant should be set with +the Zenodo id of the grant If not recognized by Zenodo, the function will raise a warning only.

    + + +
    sandbox
    +

    Use the Zenodo sandbox infrastructure as basis to control available grants. Default is FALSE

    + + +

    +
    +

    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

    @@ -1659,12 +1684,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

    @@ -1675,12 +1700,12 @@

    Arguments

    Method setJournalVolume()

    Set Journal volume to the record metadata

    -

    Usage

    +

    Usage

    ZenodoRecord$setJournalVolume(volume)

    -

    Arguments

    +

    Arguments

    volume

    a volume

    @@ -1691,12 +1716,12 @@

    Arguments

    Method setJournalIssue()

    Set Journal issue to the record metadata

    -

    Usage

    +

    Usage

    ZenodoRecord$setJournalIssue(issue)

    -

    Arguments

    +

    Arguments

    issue

    an issue

    @@ -1707,12 +1732,12 @@

    Arguments

    Method setJournalPages()

    Set Journal pages to the record metadata

    -

    Usage

    +

    Usage

    ZenodoRecord$setJournalPages(pages)

    -

    Arguments

    +

    Arguments

    pages

    number of pages

    @@ -1723,12 +1748,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

    @@ -1739,12 +1764,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

    @@ -1755,12 +1780,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

    @@ -1771,12 +1796,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

    @@ -1787,12 +1812,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

    @@ -1803,12 +1828,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

    @@ -1819,12 +1844,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

    @@ -1835,12 +1860,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

    @@ -1851,12 +1876,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

    @@ -1867,12 +1892,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

    @@ -1883,12 +1908,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

    @@ -1899,12 +1924,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

    @@ -1915,12 +1940,12 @@

    Arguments

    Method setThesisUniversity()

    Set thesis university

    -

    Usage

    +

    Usage

    ZenodoRecord$setThesisUniversity(university)

    -

    Arguments

    +

    Arguments

    university

    the university, object of class character

    @@ -1931,7 +1956,7 @@

    Arguments

    Method addThesisSupervisor()

    Adds thesis supervisor

    -

    Usage

    +

    Usage

    ZenodoRecord$addThesisSupervisor(
   firstname,
   lastname,
@@ -1942,7 +1967,7 @@ 
    Usage
 
 
    
-
    Arguments
    
+
    Arguments
    
 
    firstname
    
 
    supervisor first name
    
 
@@ -1971,12 +1996,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
    
 
@@ -1995,12 +2020,12 @@ 
    Returns
    
 
    Method removeThesisSupervisorByName()
    
 
    Removes a thesis supervisor by name.
    
-
    Usage
    
+
    Usage
    
 
    ZenodoRecord$removeThesisSupervisorByName(name)
    
 
    
 
 
    
-
    Arguments
    
+
    Arguments
    
 
    name
    
 
    thesis supervisor name
    
 
@@ -2015,12 +2040,12 @@ 
    Returns
    
 
    Method removeThesisSupervisorByAffiliation()
    
 
    Removes a thesis supervisor by affiliation
    
-
    Usage
    
+
    Usage
    
 
    ZenodoRecord$removeThesisSupervisorByAffiliation(affiliation)
    
 
    
 
 
    
-
    Arguments
    
+
    Arguments
    
 
    affiliation
    
 
    thesis supervisor affiliation
    
 
@@ -2035,12 +2060,12 @@ 
    Returns
    
 
    Method removeThesisSupervisorByORCID()
    
 
    Removes a thesis supervisor by ORCID
    
-
    Usage
    
+
    Usage
    
 
    ZenodoRecord$removeThesisSupervisorByORCID(orcid)
    
 
    
 
 
    
-
    Arguments
    
+
    Arguments
    
 
    orcid
    
 
    thesis supervisor ORCID
    
 
@@ -2055,12 +2080,12 @@ 
    Returns
    
 
    Method removeThesisSupervisorByGND()
    
 
    Removes a thesis supervisor by GND
    
-
    Usage
    
+
    Usage
    
 
    ZenodoRecord$removeThesisSupervisorByGND(gnd)
    
 
    
 
 
    
-
    Arguments
    
+
    Arguments
    
 
    gnd
    
 
    thesis supervisor GND
    
 
@@ -2075,12 +2100,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)
    
 
@@ -2103,12 +2128,12 @@ 
    Arguments
    
 
    Method removeLocation()
    
 
    Removes a grant from the record metadata.
    
-
    Usage
    
+
    Usage
    
 
    ZenodoRecord$removeLocation(place)
    
 
    
 
 
    
-
    Arguments
    
+
    Arguments
    
 
    place
    
 
    place (required)
    
 
@@ -2123,12 +2148,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
    
@@ -2153,12 +2178,12 @@ 
    Returns
    
 
    Method exportAsBibTeX()
    
 
    Exports record as BibTeX
    
-
    Usage
    
+
    Usage
    
 
    ZenodoRecord$exportAsBibTeX(filename)
    
 
    
 
 
    
-
    Arguments
    
+
    Arguments
    
 
    filename
    
 
    the target filename (without extension)
    
 
@@ -2173,12 +2198,12 @@ 
    Returns
    
 
    Method exportAsCSL()
    
 
    Exports record as CSL
    
-
    Usage
    
+
    Usage
    
 
    ZenodoRecord$exportAsCSL(filename)
    
 
    
 
 
    
-
    Arguments
    
+
    Arguments
    
 
    filename
    
 
    the target filename (without extension)
    
 
@@ -2193,12 +2218,12 @@ 
    Returns
    
 
    Method exportAsDataCite()
    
 
    Exports record as DataCite
    
-
    Usage
    
+
    Usage
    
 
    ZenodoRecord$exportAsDataCite(filename)
    
 
    
 
 
    
-
    Arguments
    
+
    Arguments
    
 
    filename
    
 
    the target filename (without extension)
    
 
@@ -2213,12 +2238,12 @@ 
    Returns
    
 
    Method exportAsDublinCore()
    
 
    Exports record as DublinCore
    
-
    Usage
    
+
    Usage
    
 
    ZenodoRecord$exportAsDublinCore(filename)
    
 
    
 
 
    
-
    Arguments
    
+
    Arguments
    
 
    filename
    
 
    the target filename (without extension)
    
 
@@ -2233,12 +2258,12 @@ 
    Returns
    
 
    Method exportAsDCAT()
    
 
    Exports record as DCAT
    
-
    Usage
    
+
    Usage
    
 
    ZenodoRecord$exportAsDCAT(filename)
    
 
    
 
 
    
-
    Arguments
    
+
    Arguments
    
 
    filename
    
 
    the target filename (without extension)
    
 
@@ -2253,12 +2278,12 @@ 
    Returns
    
 
    Method exportAsJSON()
    
 
    Exports record as JSON
    
-
    Usage
    
+
    Usage
    
 
    ZenodoRecord$exportAsJSON(filename)
    
 
    
 
 
    
-
    Arguments
    
+
    Arguments
    
 
    filename
    
 
    the target filename (without extension)
    
 
@@ -2273,12 +2298,12 @@ 
    Returns
    
 
    Method exportAsJSONLD()
    
 
    Exports record as JSONLD
    
-
    Usage
    
+
    Usage
    
 
    ZenodoRecord$exportAsJSONLD(filename)
    
 
    
 
 
    
-
    Arguments
    
+
    Arguments
    
 
    filename
    
 
    the target filename (without extension)
    
 
@@ -2289,12 +2314,12 @@ 
    Arguments
    
 
    Method exportAsGeoJSON()
    
 
    Exports record as GeoJSON
    
-
    Usage
    
+
    Usage
    
 
    ZenodoRecord$exportAsGeoJSON(filename)
    
 
    
 
 
    
-
    Arguments
    
+
    Arguments
    
 
    filename
    
 
    the target filename (without extension)
    
 
@@ -2309,12 +2334,12 @@ 
    Returns
    
 
    Method exportAsMARCXML()
    
 
    Exports record as MARCXML
    
-
    Usage
    
+
    Usage
    
 
    ZenodoRecord$exportAsMARCXML(filename)
    
 
    
 
 
    
-
    Arguments
    
+
    Arguments
    
 
    filename
    
 
    the target filename (without extension)
    
 
@@ -2330,12 +2355,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)
    
 
@@ -2346,12 +2371,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.
    
@@ -2367,7 +2392,7 @@ 
    Returns
    
 
    Method downloadFiles()
    
 
    Downloads files attached to the record
    
-
    Usage
    
+
    Usage
    
 
    ZenodoRecord$downloadFiles(
   path = ".",
   files = list(),
@@ -2382,7 +2407,7 @@ 
    Usage
 
 
    
-
    Arguments
    
+
    Arguments
    
 
    path
    
 
    target download path (by default it will be the current working directory)
    
 
@@ -2429,12 +2454,12 @@ 
    Arguments
    
 
    Method print()
    
 
    Prints a ZenodoRecord
    
-
    Usage
    
+
    Usage
    
 
    ZenodoRecord$print(..., format = "internal", depth = 1)
    
 
    
 
 
    
-
    Arguments
    
+
    Arguments
    
 
    ...
    
 
    any other parameter. Not used
    
 
@@ -2456,7 +2481,7 @@ 
    Arguments
    
 
    Method toDCEntry()
    
 
    Maps to an atom4R DCEntry. Note: applies only to published records.
    
-
    Usage
    
+
    Usage
    
 
    ZenodoRecord$toDCEntry()
    
 
    
 
@@ -2468,7 +2493,7 @@ 
    Returns
    
 
    Method getFirstDOI()
    
 
    Get DOI of the first record version.
    
-
    Usage
    
+
    Usage
    
 
    ZenodoRecord$getFirstDOI()
    
 
    
 
@@ -2480,7 +2505,7 @@ 
    Returns
    
 
    Method getLastDOI()
    
 
    Get DOI of the latest record version.
    
-
    Usage
    
+
    Usage
    
 
    ZenodoRecord$getLastDOI()
    
 
    
 
@@ -2493,7 +2518,7 @@ 
    ReturnsMethod getVersions()
    
 
    Get record versions with creation/publication date, 
   version (ordering number) and DOI.
    
-
    Usage
    
+
    Usage
    
 
    ZenodoRecord$getVersions()
    
 
    
 
@@ -2505,12 +2530,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/get_zenodo.html b/reference/get_zenodo.html
index 3dcffe5..3ccfc7b 100644
--- a/reference/get_zenodo.html
+++ b/reference/get_zenodo.html
@@ -199,16 +199,16 @@ 
    Examples
    
 #> ............|-- identifier: oai:zenodo.org:7552287
 #> ............|-- provider: oai
 #> ....|-- stats:
-#>     ↓ this_version.downloads = 123
-#>     ↓ this_version.unique_downloads = 84
-#>     ↓ all_versions.downloads = 1588
-#>     ↓ all_versions.unique_downloads = 719
+#>     ↓ this_version.downloads = 127
+#>     ↓ this_version.unique_downloads = 86
+#>     ↓ all_versions.downloads = 1592
+#>     ↓ all_versions.unique_downloads = 721
 #>     👁 this_version.views = 145
 #>     👁 this_version.unique_views = 141
-#>     👁 all_versions.views = 1635
-#>     👁 all_versions.unique_views = 1472
-#>     ■ this_version.data_volume = 7524288
-#>     ■ all_versions.data_volume = 59556085
+#>     👁 all_versions.views = 1638
+#>     👁 all_versions.unique_views = 1475
+#>     ■ this_version.data_volume = 7768762
+#>     ■ all_versions.data_volume = 59800559
 # }