ZenodoRecord | R Documentation |
ZenodoRecord
ZenodoRecord
R6Class
object.
Object of R6Class
for modelling an ZenodoRecord
zen4R::zen4RLogger
-> ZenodoRecord
access
access policies
conceptdoi
record Concept DOI (common to all record versions)
conceptrecid
record concept id
created
record creation date
doi
record doi
doi_url
record doi URL
files
list of files associated to the record
id
record id
links
list of links associated to the record
metadata
metadata elements associated to the record
modified
record modification date
owners
record owners
recid
recid
status
record status
state
record state
submitted
record submission status
revision
record revision
stats
stats
new()
method is used to instantiate a ZenodoRecord
ZenodoRecord$new(obj = NULL, logger = "INFO")
obj
an optional list object to create the record
logger
a logger to print log messages. It can be either NULL, "INFO" (with minimum logs), or "DEBUG" (for complete curl http calls logs)
setAccessPolicyRecord()
Set the access policy for record, among values "public" (default) or "restricted"
ZenodoRecord$setAccessPolicyRecord(access = c("public", "resticted"))
access
access policy ('public' or 'restricted')
setAccessPolicyFiles()
Set the access policy for files, among values "public" (default) or "restricted"
ZenodoRecord$setAccessPolicyFiles(access = c("public", "resticted"))
access
access policy ('public' or 'restricted')
setAccessPolicyEmbargo()
Set access policy embargo options
ZenodoRecord$setAccessPolicyEmbargo(active = FALSE, until = NULL, reason = "")
active
whether embargo is active or not. Default is FALSE
until
embargo date, object of class Date
. Default is NULL
. Must be provided if embargo is active
reason
embargo reason, object of class character
. Default is an empty string
prereserveDOI()
Set prereserve_doi if TRUE
, FALSE
otherwise to create a record without
prereserved DOI by Zenodo. By default, this method will be called to prereserve a DOI assuming
the record created doesn't yet handle a DOI. To avoid prereserving a DOI call $prereserveDOI(FALSE)
on your record.
ZenodoRecord$prereserveDOI(prereserve)
prereserve
whether a DOI has to be pre-reserved by Zenodo
setDOI()
Set the DOI. This method can be used if a DOI has been already assigned outside Zenodo.
This method will call the method $prereserveDOI(FALSE)
.
ZenodoRecord$setDOI(doi)
doi
DOI to set for the record
getConceptDOI()
Get the concept (generic) DOI. The concept DOI is a generic DOI common to all versions of a Zenodo record. When a deposit is unsubmitted, this concept DOI is inherited based on the prereserved DOI of the first record version.
ZenodoRecord$getConceptDOI()
the concept DOI, object of class character
getFirstDOI()
Get DOI of the first record version.
ZenodoRecord$getFirstDOI()
the first DOI, object of class character
getLastDOI()
Get DOI of the latest record version.
ZenodoRecord$getLastDOI()
the last DOI, object of class character
getVersions()
Get record versions with creation/publication date, version (ordering number) and DOI.
ZenodoRecord$getVersions()
a data.frame
with the record versions
getStats()
Get record statistics
ZenodoRecord$getStats()
statistics as data.frame
setResourceType()
Set the resource type (mandatory).
ZenodoRecord$setResourceType(resourceType)
resourceType
record resource type
setUploadType()
Set the upload type (mandatory). Deprecated since zen4R 1.0
ZenodoRecord$setUploadType(uploadType)
uploadType
record upload type among the following values: 'publication', 'poster', 'presentation', 'dataset', 'image', 'video', 'software', 'lesson', 'physicalobject', 'other'
setPublicationType()
Set the publication type (mandatory if upload type is 'publication'). Deprecated since zen4R 1.0
ZenodoRecord$setPublicationType(publicationType)
publicationType
record publication type among the following values: 'annotationcollection', 'book', 'section', 'conferencepaper', 'datamanagementplan', 'article', 'patent', 'preprint', 'deliverable', 'milestone', 'proposal', 'report', 'softwaredocumentation', 'taxonomictreatment', 'technicalnote', 'thesis', 'workingpaper', 'other'
setImageType()
Set the image type (mandatory if image type is 'image'). Deprecated since zen4R 1.0
ZenodoRecord$setImageType(imageType)
imageType
record publication type among the following values: 'figure','plot', 'drawing','diagram','photo', or 'other'
setPublisher()
Set the publisher
ZenodoRecord$setPublisher(publisher)
publisher
publisher object of class character
setPublicationDate()
Set the publication date. For more information on the accepted format, please check https://inveniordm.docs.cern.ch/reference/metadata/#publication-date-1
ZenodoRecord$setPublicationDate(publicationDate)
publicationDate
object of class character
setEmbargoDate()
Set the embargo date.
ZenodoRecord$setEmbargoDate(embargoDate)
embargoDate
object of class Date
setTitle()
Set the record title.
ZenodoRecord$setTitle(title)
title
object of class character
setDescription()
Set the record description
ZenodoRecord$setDescription(description)
description
object of class character
setAccessRight()
Set the access right.
ZenodoRecord$setAccessRight(accessRight)
accessRight
record access right among the following values: 'open','embargoed', 'restricted','closed'
setAccessConditions()
set the access conditions.
ZenodoRecord$setAccessConditions(accessConditions)
accessConditions
object of class character
addPersonOrOrg()
Add a person or organization for the record. For persons, the approach is to use the firstname
and
lastname
arguments, that by default will be concatenated for Zenodo as lastname, firstname
.
For organizations, use the name
argument.
ZenodoRecord$addPersonOrOrg( firstname = NULL, lastname = NULL, name = paste(lastname, firstname, sep = ", "), orcid = NULL, gnd = NULL, isni = NULL, ror = NULL, role = NULL, affiliations = NULL, sandbox = FALSE, type )
firstname
person first name
lastname
person last name
name
organization name
orcid
person or organization ORCID (optional)
gnd
person or organization GND (optional)
isni
person or organization ISNI (optional)
ror
person or organization ROR (optional)
role
role, values among: ContactPerson, DataCollector, DataCurator, DataManager, Distributor, Editor, Funder, HostingInstitution, Producer, ProjectLeader, ProjectManager, ProjectMember, RegistrationAgency, RegistrationAuthority, RelatedPerson, Researcher, ResearchGroup, RightsHolder, Supervisor, Sponsor, WorkPackageLeader, Other
affiliations
person or organization affiliations (optional)
sandbox
Use the Zenodo sandbox infrastructure as basis to control available affiliations. Default is FALSE
type
type of person or org (creators/contributors)
TRUE
if added, FALSE
otherwise
removePersonOrOrg()
Removes a person or organization by a property. The by
parameter should be the name
of the person or organization property ('name', 'affiliation','orcid','gnd','isni','ror').
ZenodoRecord$removePersonOrOrg(by, property, type)
by
property used as criterion to remove the person or organization
property
property value used to remove the person or organization
type
type of person or org (creators / contributors)
TRUE
if removed, FALSE
otherwise
addCreator()
Add a creator for the record. For persons, the approach is to use the firstname
and
lastname
arguments, that by default will be concatenated for Zenodo as lastname, firstname
.
For organizations, use the name
argument.
ZenodoRecord$addCreator( firstname = NULL, lastname = NULL, name = paste(lastname, firstname, sep = ", "), orcid = NULL, gnd = NULL, isni = NULL, ror = NULL, role = NULL, affiliations = NULL, sandbox = FALSE )
firstname
person first name
lastname
person last name
name
organization name
orcid
creator ORCID (optional)
gnd
creator GND (optional)
isni
creator ISNI (optional)
ror
creator ROR (optional)
role
role, values among: ContactPerson, DataCollector, DataCurator, DataManager, Distributor, Editor, Funder, HostingInstitution, Producer, ProjectLeader, ProjectManager, ProjectMember, RegistrationAgency, RegistrationAuthority, RelatedPerson, Researcher, ResearchGroup, RightsHolder, Supervisor, Sponsor, WorkPackageLeader, Other
affiliations
creator affiliations (optional)
sandbox
Use the Zenodo sandbox infrastructure as basis to control available affiliations. Default is FALSE
TRUE
if added, FALSE
otherwise
removeCreatorByName()
Removes a creator by name.
ZenodoRecord$removeCreatorByName(name)
name
creator name
TRUE
if removed, FALSE
otherwise
removeCreatorByAffiliation()
Removes a creator by affiliation.
ZenodoRecord$removeCreatorByAffiliation(affiliation)
affiliation
creator affiliation
TRUE
if removed, FALSE
otherwise
removeCreatorByORCID()
Removes a creator by ORCID.
ZenodoRecord$removeCreatorByORCID(orcid)
orcid
creator ORCID
TRUE
if removed, FALSE
otherwise
removeCreatorByGND()
Removes a creator by GND.
ZenodoRecord$removeCreatorByGND(gnd)
gnd
creator GND
TRUE
if removed, FALSE
otherwise
removeCreatorByISNI()
Removes a creator by ISNI.
ZenodoRecord$removeCreatorByISNI(isni)
isni
creator ISNI
TRUE
if removed, FALSE
otherwise
removeCreatorByROR()
Removes a creator by ROR.
ZenodoRecord$removeCreatorByROR(ror)
ror
creator ROR
TRUE
if removed, FALSE
otherwise
addContributor()
Add a contributor for the record. For persons, the approach is to use the firstname
and
lastname
arguments, that by default will be concatenated for Zenodo as lastname, firstname
.
For organizations, use the name
argument.
ZenodoRecord$addContributor( firstname = NULL, lastname = NULL, name = paste(lastname, firstname, sep = ", "), orcid = NULL, gnd = NULL, isni = NULL, ror = NULL, role = NULL, affiliations = NULL, sandbox = FALSE )
firstname
person first name
lastname
person last name
name
organization name
orcid
contributor ORCID (optional)
gnd
contributor GND (optional)
isni
contributor ISNI (optional)
ror
contributor ROR (optional)
role
role, values among: ContactPerson, DataCollector, DataCurator, DataManager, Distributor, Editor, Funder, HostingInstitution, Producer, ProjectLeader, ProjectManager, ProjectMember, RegistrationAgency, RegistrationAuthority, RelatedPerson, Researcher, ResearchGroup, RightsHolder, Supervisor, Sponsor, WorkPackageLeader, Other
affiliations
contributor affiliations (optional)
sandbox
Use the Zenodo sandbox infrastructure as basis to control available affiliations. Default is FALSE
TRUE
if added, FALSE
otherwise
removeContributorByName()
Removes a contributor by name.
ZenodoRecord$removeContributorByName(name)
name
contributor name
TRUE
if removed, FALSE
otherwise
removeContributorByAffiliation()
Removes a contributor by affiliation.
ZenodoRecord$removeContributorByAffiliation(affiliation)
affiliation
contributor affiliation
TRUE
if removed, FALSE
otherwise
removeContributorByORCID()
Removes a contributor by ORCID.
ZenodoRecord$removeContributorByORCID(orcid)
orcid
contributor ORCID
TRUE
if removed, FALSE
otherwise
removeContributorByGND()
Removes a contributor by GND.
ZenodoRecord$removeContributorByGND(gnd)
gnd
contributor GND
TRUE
if removed, FALSE
otherwise
removeContributorByISNI()
Removes a contributor by ISNI.
ZenodoRecord$removeContributorByISNI(isni)
isni
contributor ISNI
TRUE
if removed, FALSE
otherwise
removeContributorByROR()
Removes a contributor by ROR.
ZenodoRecord$removeContributorByROR(ror)
ror
contributor ROR
TRUE
if removed, FALSE
otherwise
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()
.
ZenodoRecord$setLicense(licenseId, sandbox = FALSE)
licenseId
a license Id
sandbox
Use the Zenodo sandbox infrastructure as basis to control available licenses. Default is FALSE
setVersion()
Set record version.
ZenodoRecord$setVersion(version)
version
the record version to set
addLanguage()
Adds a language.
ZenodoRecord$addLanguage(language)
language
ISO 639-2 or 639-3 code
setLanguage()
Set the language
ZenodoRecord$setLanguage(language)
language
ISO 639-2 or 639-3 code
addRelatedIdentifier()
Adds a related identifier with a given relation.
ZenodoRecord$addRelatedIdentifier(relation, identifier, resource_type = NULL)
relation
relation type among following values: isCitedBy, cites, isSupplementTo, isSupplementedBy, isContinuedBy, continues, isDescribedBy, describes, hasMetadata, isMetadataFor, isNewVersionOf, isPreviousVersionOf, isPartOf, hasPart, isReferencedBy, references, isDocumentedBy, documents, isCompiledBy, compiles, isVariantFormOf, isOriginalFormof, isIdenticalTo, isAlternateIdentifier, isReviewedBy, reviews, isDerivedFrom, isSourceOf, requires, isRequiredBy, isObsoletedBy, obsoletes
identifier
resource identifier
resource_type
optional resource type, value among possible publication types, image types, or upload
types (except 'publication' and 'image' for which a publication/image has to be specified). Default is NULL
removeRelatedIdentifier()
Removes a related identifier with a given relation.
ZenodoRecord$removeRelatedIdentifier(relation, identifier)
relation
relation type among following values: isCitedBy, cites, isSupplementTo, isSupplementedBy, isContinuedBy, continues, isDescribedBy, describes, hasMetadata, isMetadataFor, isNewVersionOf, isPreviousVersionOf, isPartOf, hasPart, isReferencedBy, references, isDocumentedBy, documents, isCompiledBy, compiles, isVariantFormOf, isOriginalFormof, isIdenticalTo, isAlternateIdentifier, isReviewedBy, reviews, isDerivedFrom, isSourceOf, requires, isRequiredBy, isObsoletedBy, obsoletes
identifier
resource identifier
setReferences()
Set references
ZenodoRecord$setReferences(references)
references
a vector or list of references to set for the record
addReference()
Add a reference
ZenodoRecord$addReference(reference)
reference
the reference to add
TRUE
if added, FALSE
otherwise
removeReference()
Remove a reference
ZenodoRecord$removeReference(reference)
reference
the reference to remove
TRUE
if removed, FALSE
otherwise
setKeywords()
Set keywords
ZenodoRecord$setKeywords(keywords)
keywords
a vector or list of keywords to set for the record
addKeyword()
Add a keyword
ZenodoRecord$addKeyword(keyword)
keyword
the keyword to add
TRUE
if added, FALSE
otherwise
removeKeyword()
Remove a keyword
ZenodoRecord$removeKeyword(keyword)
keyword
the keyword to remove
TRUE
if removed, FALSE
otherwise
addSubject()
Adds a subject given a term and identifier
ZenodoRecord$addSubject(term, identifier)
term
subject term
identifier
subject identifier
removeSubject()
Removes subject(s) by a property. The by
parameter should be the name
of the subject property ('term' or 'identifier').
ZenodoRecord$removeSubject(by, property)
by
property used as criterion to remove subjects
property
property value used to remove subjects
TRUE
if at least one subject is removed, FALSE
otherwise.
removeSubjectByTerm()
Removes subject(s) by term.
ZenodoRecord$removeSubjectByTerm(term)
term
the term to use to remove subject(s)
TRUE
if at least one subject is removed, FALSE
otherwise.
removeSubjectByIdentifier()
Removes subject(s) by identifier
ZenodoRecord$removeSubjectByIdentifier(identifier)
identifier
the identifier to use to remove subject(s)
TRUE
if at least one subject is removed, FALSE
otherwise.
setNotes()
Set notes. HTML is not allowed
ZenodoRecord$setNotes(notes)
notes
object of class character
setCommunities()
Set a vector of character strings identifying communities
ZenodoRecord$setCommunities(communities, sandbox = FALSE)
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
the Zenodo id of the community. If not recognized by Zenodo, the function will return an error.
sandbox
Use the Zenodo sandbox infrastructure as basis to control available communities. Default is FALSE
addCommunity()
Adds a community to the record metadata.
ZenodoRecord$addCommunity(community, sandbox = FALSE)
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
with the ZenodoManager
and the function $getCommunities()
.
sandbox
Use the Zenodo sandbox infrastructure as basis to control available communities. Default is FALSE
TRUE
if added, FALSE
otherwise
removeCommunity()
Removes a community from the record metadata.
ZenodoRecord$removeCommunity(community)
community
community to remove. The community should be set with the Zenodo id of the community.
TRUE
if removed, FALSE
otherwise
setGrants()
Set a vector of character strings identifying grants
ZenodoRecord$setGrants(grants, sandbox = FALSE)
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.
sandbox
Use the Zenodo sandbox infrastructure as basis to control available grants. Default is FALSE
addGrant()
Adds a grant to the record metadata.
ZenodoRecord$addGrant(grant, sandbox = FALSE)
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()
.
sandbox
Use the Zenodo sandbox infrastructure as basis to control available grants. Default is FALSE
TRUE
if added, FALSE
otherwise
removeGrant()
Removes a grant from the record metadata.
ZenodoRecord$removeGrant(grant)
grant
grant to remove. The grant should be set with the Zenodo id of the grant
TRUE
if removed, FALSE
otherwise
setJournalTitle()
Set Journal title to the record metadata
ZenodoRecord$setJournalTitle(title)
title
a title, object of class character
setJournalVolume()
Set Journal volume to the record metadata
ZenodoRecord$setJournalVolume(volume)
volume
a volume
setJournalIssue()
Set Journal issue to the record metadata
ZenodoRecord$setJournalIssue(issue)
issue
an issue
setJournalPages()
Set Journal pages to the record metadata
ZenodoRecord$setJournalPages(pages)
pages
number of pages
setConferenceTitle()
Set conference title to the record metadata
ZenodoRecord$setConferenceTitle(title)
title
conference title, object of class character
setConferenceAcronym()
Set conference acronym to the record metadata
ZenodoRecord$setConferenceAcronym(acronym)
acronym
conference acronym, object of class character
setConferenceDates()
Set conference dates to the record metadata
ZenodoRecord$setConferenceDates(dates)
dates
conference dates, object of class character
setConferencePlace()
Set conference place to the record metadata
ZenodoRecord$setConferencePlace(place)
place
conference place, object of class character
setConferenceUrl()
Set conference url to the record metadata
ZenodoRecord$setConferenceUrl(url)
url
conference url, object of class character
setConferenceSession()
Set conference session to the record metadata
ZenodoRecord$setConferenceSession(session)
session
conference session, object of class character
setConferenceSessionPart()
Set conference session part to the record metadata
ZenodoRecord$setConferenceSessionPart(part)
part
conference session part, object of class character
setImprintPublisher()
Set imprint publisher to the record metadata
ZenodoRecord$setImprintPublisher(publisher)
publisher
the publisher, object of class character
setImprintISBN()
Set imprint ISBN to the record metadata
ZenodoRecord$setImprintISBN(isbn)
isbn
the ISBN, object of class character
setImprintPlace()
Set imprint place to the record metadata
ZenodoRecord$setImprintPlace(place)
place
the place, object of class character
setPartofTitle()
Set title to which record is part of
ZenodoRecord$setPartofTitle(title)
title
the title, object of class character
setPartofPages()
Set pages to which record is part of
ZenodoRecord$setPartofPages(pages)
pages
the pages, object of class character
setThesisUniversity()
Set thesis university
ZenodoRecord$setThesisUniversity(university)
university
the university, object of class character
addThesisSupervisor()
Adds thesis supervisor
ZenodoRecord$addThesisSupervisor( firstname, lastname, affiliation = NULL, orcid = NULL, gnd = NULL )
firstname
supervisor first name
lastname
supervisor last name
affiliation
supervisor affiliation (optional)
orcid
supervisor ORCID (optional)
gnd
supervisor GND (optional)
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').
ZenodoRecord$removeThesisSupervisor(by, property)
by
property used as criterion to remove the thesis supervisor
property
property value used to remove the thesis supervisor
TRUE
if removed, FALSE
otherwise
removeThesisSupervisorByName()
Removes a thesis supervisor by name.
ZenodoRecord$removeThesisSupervisorByName(name)
name
thesis supervisor name
TRUE
if removed, FALSE
otherwise
removeThesisSupervisorByAffiliation()
Removes a thesis supervisor by affiliation
ZenodoRecord$removeThesisSupervisorByAffiliation(affiliation)
affiliation
thesis supervisor affiliation
TRUE
if removed, FALSE
otherwise
removeThesisSupervisorByORCID()
Removes a thesis supervisor by ORCID
ZenodoRecord$removeThesisSupervisorByORCID(orcid)
orcid
thesis supervisor ORCID
TRUE
if removed, FALSE
otherwise
removeThesisSupervisorByGND()
Removes a thesis supervisor by GND
ZenodoRecord$removeThesisSupervisorByGND(gnd)
gnd
thesis supervisor GND
TRUE
if removed, FALSE
otherwise
addLocation()
Adds a location to the record metadata.
ZenodoRecord$addLocation(place, description = NULL, lat = NULL, lon = NULL)
place
place (required)
description
description
lat
latitude
lon
longitude
removeLocation()
Removes a grant from the record metadata.
ZenodoRecord$removeLocation(place)
place
place (required)
TRUE
if removed, FALSE
otherwise
exportAs()
Exports record to a file by format.
ZenodoRecord$exportAs(format, filename, append_format = TRUE)
format
the export format to use. Possibles values are: BibTeX, CSL, DataCite, DublinCore, DCAT, JSON, JSON-LD, GeoJSON, MARCXML
filename
the target filename (without extension)
append_format
wether format name has to be appended to the filename. Default is TRUE
(for
backward compatibility reasons). Set it to FALSE
if you want to use only the filename
.
the writen file name (with extension)
exportAsBibTeX()
Exports record as BibTeX
ZenodoRecord$exportAsBibTeX(filename)
filename
the target filename (without extension)
the writen file name (with extension)
exportAsCSL()
Exports record as CSL
ZenodoRecord$exportAsCSL(filename)
filename
the target filename (without extension)
the writen file name (with extension)
exportAsDataCite()
Exports record as DataCite
ZenodoRecord$exportAsDataCite(filename)
filename
the target filename (without extension)
the writen file name (with extension)
exportAsDublinCore()
Exports record as DublinCore
ZenodoRecord$exportAsDublinCore(filename)
filename
the target filename (without extension)
the writen file name (with extension)
exportAsDCAT()
Exports record as DCAT
ZenodoRecord$exportAsDCAT(filename)
filename
the target filename (without extension)
the writen file name (with extension)
exportAsJSON()
Exports record as JSON
ZenodoRecord$exportAsJSON(filename)
filename
the target filename (without extension)
the writen file name (with extension)
exportAsJSONLD()
Exports record as JSONLD
ZenodoRecord$exportAsJSONLD(filename)
filename
the target filename (without extension)
exportAsGeoJSON()
Exports record as GeoJSON
ZenodoRecord$exportAsGeoJSON(filename)
filename
the target filename (without extension)
the writen file name (with extension)
exportAsMARCXML()
Exports record as MARCXML
ZenodoRecord$exportAsMARCXML(filename)
filename
the target filename (without extension)
the writen file name (with extension)
exportAsAllFormats()
Exports record in all Zenodo record export formats. This function will create one file per Zenodo metadata formats.
ZenodoRecord$exportAsAllFormats(filename)
filename
the target filename (without extension)
listFiles()
list files attached to the record
ZenodoRecord$listFiles(pretty = TRUE)
pretty
whether a pretty output (data.frame
) should be returned (default TRUE
), otherwise
the raw list of files is returned.
the files, as data.frame
or list
downloadFiles()
Downloads files attached to the record
ZenodoRecord$downloadFiles( path = ".", files = list(), parallel = FALSE, parallel_handler = NULL, cl = NULL, quiet = FALSE, overwrite = TRUE, timeout = 60, ... )
path
target download path (by default it will be the current working directory)
files
(list of) file(s) to download. If not specified, by default all files will be downloaded.
parallel
whether download has to be done in parallel using the chosen parallel_handler
. Default is FALSE
parallel_handler
The parallel handler to use eg. mclapply
. To use a different parallel handler (such as eg
parLapply
or parSapply
), specify its function in parallel_handler
argument. For cluster-based parallel
download, this is the way to proceed. In that case, the cluster should be created earlier by the user with makeCluster
and passed as cl
argument. After downloading all files, the cluster will be stopped automatically.
cl
an optional cluster for cluster-based parallel handlers
quiet
(default is FALSE
) can be set to suppress informative messages (not warnings).
overwrite
(default is TRUE
) can be set to FALSE to avoid re-downloading existing files.
timeout
(default is 60s) see download.file
.
...
arguments inherited from parallel::mclapply
or the custom parallel_handler
can be added (eg. mc.cores
for mclapply
)
print()
Prints a ZenodoRecord
ZenodoRecord$print(..., format = "internal", depth = 1)
...
any other parameter. Not used
format
format to use for printing. By default, internal
uses an zen4R internal
printing method. Other methods available are those supported by Zenodo for record export, and can be used
only if the record has already been published (with a DOI). Attemps to print using a Zenodo export format
for a record will raise a warning message and revert to "internal" format
depth
an internal depth parameter for indentation of print statements, in case of listing or recursive use of print
toDCEntry()
Maps to an atom4R DCEntry. Note: applies only to published records.
ZenodoRecord$toDCEntry()
an object of class DCEntry
clone()
The objects of this class are cloneable with this method.
ZenodoRecord$clone(deep = FALSE)
deep
Whether to make a deep clone.
Internal method. Prefer using addCreator
or addContributor
Internal method. Prefer using removeCreator
or removeContributor
See examples in download_zenodo
utility function.
Emmanuel Blondel <emmanuel.blondel1@gmail.com>
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.