Movatterモバイル変換

sandbox

Zenodo manager sandbox status,TRUE if we interact with Sandbox infra

anonymous

Zenodo manager anonymous status,TRUE when no token is specified

ZenodoManager$new(  url = "https://zenodo.org/api",  token = zenodo_pat(),  sandbox = FALSE,  logger = NULL,  keyring_backend = "env")

url

Zenodo API URL. By default, the url is set to "https://zenodo.org/api". For tests, the Zenodo sandbox API URL can be used: https://sandbox.zenodo.org/api

token

the user token. By default an attempt will be made to retrieve token usingzenodo_pat

sandbox

Indicates if the Zenodo sandbox platform should be used. Default isFALSE

logger

logger type. The logger can be either NULL, "INFO" (with minimum logs), or "DEBUG" (for complete curl http calls logs)

keyring_backend

Thekeyring backend used to store user token. Thekeyring_backend can be set to use a different backend for storing the Zenodo token withkeyring (Default value is 'env').

ZenodoManager$getToken()

ZenodoManager$checkUserAuthentication()

ZenodoManager$getLanguages(pretty = TRUE)

pretty

Prettify the output. By default the argumentpretty is set toTRUE which will returns the list of languages asdata.frame.Setpretty = FALSE to get the raw list of languages

ZenodoManager$getLanguageById(id)

id

license id

ZenodoManager$getLicenses(pretty = TRUE)

pretty

Prettify the output. By default the argumentpretty is set toTRUE which will returns the list of licenses asdata.frame.Setpretty = FALSE to get the raw list of licenses.

ZenodoManager$getLicenseById(id)

id

license id

ZenodoManager$getResourceTypes(pretty = TRUE)

pretty

Prettify the output. By default the argumentpretty is set toTRUE which will returns the list of resource types asdata.frame.Setpretty = FALSE to get the raw list of resource types

ZenodoManager$getResourceTypeById(id)

id

resource type id

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

pretty

Prettify the output. By default the argumentpretty is set toTRUE which will returns the list of communities asdata.frame.Setpretty = FALSE to get the raw list of communities

q

an ElasticSearch compliant query, object of classcharacter. Default is emtpy.Note that the Zenodo API restrains a maximum number of 10,000 records to be retrieved. Consequently,not all communities can be listed from Zenodo, a query has to be specified.

size

number of communities to be returned. By default equal to 500

ZenodoManager$getCommunityById(id)

id

community id

ZenodoManager$submitRecordToCommunities(  record,  communities = list(),  message = NULL)

record

an object of classZenodoRecord

communities

communities to which the record will be submitted

message

message to send to the community curator(s), either a text or a named listfor each community in case a community-specific message should be sent

ZenodoManager$removeRecordFromCommunities(record, communities = list())

record

an object of classZenodoRecord

communities

communities to which the record will be submitted

ZenodoManager$getRecordCommunities(record)

record

object of classZenodoRecord

ZenodoManager$createReviewRequest(record, community)

record

an object of classZenodoRecord

community

a community to which the record is submitted for review and publication

ZenodoManager$getReviewRequest(record)

record

an object of classZenodoRecord

ZenodoManager$deleteReviewRequest(record)

record

an object of classZenodoRecord

ZenodoManager$submitRecordForReview(recordId, message = NULL)

recordId

the ID of a Zenodo record

message

message content for the submission. Optional

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

q

an ElasticSearch compliant query, object of classcharacter. Default is emtpy.Note that the Zenodo API restrains a maximum number of 10,000 records to be retrieved. Consequently,not all grants can be listed from Zenodo, a query has to be specified.

pretty

Prettify the output. By default the argumentpretty is set toTRUE which will returns the list of grants asdata.frame.Setpretty = FALSE to get the raw list of grants

size

number of grants to be returned. By default equal to 500.

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

q

an ElasticSearch compliant query, object of classcharacter. Default is emtpy.Note that the Zenodo API restrains a maximum number of 10,000 records to be retrieved. Consequently,not all awards can be listed from Zenodo, a query has to be specified.

pretty

Prettify the output. By default the argumentpretty is set toTRUE which will returns the list of awards asdata.frame.Setpretty = FALSE to get the raw list of awards

size

number of awards to be returned. By default equal to 500.

ZenodoManager$getGrantsByName(name, pretty = TRUE)

name

name

pretty

Prettify the output. By default the argumentpretty is set toTRUE which will returns the list of grants asdata.frame.Setpretty = FALSE to get the raw list of grants

ZenodoManager$getAwardsByName(name, pretty = TRUE)

name

name

pretty

Prettify the output. By default the argumentpretty is set toTRUE which will returns the list of awards asdata.frame.Setpretty = FALSE to get the raw list of awards

ZenodoManager$getGrantById(id)

id

grant id

ZenodoManager$getAwardById(id)

id

award id

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

q

an ElasticSearch compliant query, object of classcharacter. Default is emtpy.Note that the Zenodo API restrains a maximum number of 10,000 records to be retrieved. Consequently,not all affiliations can be listed from Zenodo, a query has to be specified.

pretty

Prettify the output. By default the argumentpretty is set toTRUE which will returns the list of affiliations asdata.frame.Setpretty = FALSE to get the raw list of affiliations

size

number of affiliations to be returned. By default equal to 500.

ZenodoManager$getAffiliationByName(name, pretty = TRUE)

name

name

pretty

Prettify the output. By default the argumentpretty is set toTRUE which will returns the list of affiliations asdata.frame.Setpretty = FALSE to get the raw list of affiliations

ZenodoManager$getAffiliationById(id)

id

affiliation id

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

q

an ElasticSearch compliant query, object of classcharacter. Default is emtpy.Note that the Zenodo API restrains a maximum number of 10,000 records to be retrieved. Consequently,not all funders can be listed from Zenodo, a query has to be specified.

pretty

Prettify the output. By default the argumentpretty is set toTRUE which will returns the list of funders asdata.frame.Setpretty = FALSE to get the raw list of funders

size

number of funders to be returned. By default equal to 500

ZenodoManager$getFundersByName(name, pretty = TRUE)

name

name

pretty

Prettify the output. By default the argumentpretty is set toTRUE which will returns the list of funders asdata.frame.Setpretty = FALSE to get the raw list of funders

ZenodoManager$getFunderById(id)

id

funder id

ZenodoManager$getDepositions(  q = "",  size = 10,  all_versions = FALSE,  exact = TRUE,  quiet = FALSE)

q

Elastic-Search-compliant query, as object of classcharacter. Default is ""

size

number of depositions to be retrieved per request (paginated). Default is 10

all_versions

object of classlogical indicating if all versions of deposits have to be retrieved. Default isFALSE

exact

object of classlogical indicating if exact matching has to be applied. Default isTRUE

quiet

object of classlogical indicating if logs have to skipped. Default isFALSE

ZenodoManager$getDepositionByConceptDOI(conceptdoi)

conceptdoi

the concept DOI, object of classcharacter

ZenodoManager$getDepositionByDOI(doi)

doi

the DOI, object of classcharacter

ZenodoManager$getDepositionById(recid)

recid

the record ID, object of classcharacter

ZenodoManager$getDepositionByConceptId(conceptrecid)

conceptrecid

the record concept ID, object of classcharacter

ZenodoManager$depositRecord(record, reserveDOI = TRUE, publish = FALSE)

record

the record to deposit, object of classZenodoRecord

reserveDOI

reserve DOI. By defaultTRUE

publish

object of classlogical indicating if record has to be published (defaultFALSE). Can be set toTRUE (to use CAUTIOUSLY, only if you want to publish your record)

ZenodoManager$reserveDOI(record)

record

the record to deposit, object of classZenodoRecord

ZenodoManager$deleteDOI(record)

record

the record for which DOI has to be deleted, object of classZenodoRecord

ZenodoManager$depositRecordVersion(  record,  delete_latest_files = TRUE,  files = list(),  publish = FALSE)

record

the record version to deposit, object of classZenodoRecord

delete_latest_files

object of classlogical indicating if latest files have to be deleted. Default isTRUE

files

a list of files to be uploaded with the new record version

publish

object of classlogical indicating if record has to be published (defaultFALSE)

ZenodoManager$deleteRecord(recordId)

recordId

the ID of the record to be deleted

ZenodoManager$deleteRecordByDOI(doi)

doi

the DOI of the record to be deleted

ZenodoManager$deleteRecords(q = "", size = 10)

q

an ElasticSearch compliant query, object of classcharacter

size

number of records to be passed to$getDepositions method

ZenodoManager$createEmptyRecord(reserveDOI = TRUE)

reserveDOI

reserve DOI. By defaultTRUE

ZenodoManager$editRecord(recordId)

recordId

the ID of the record to unlock and set in editing mode.

ZenodoManager$discardChanges(recordId)

recordId

the ID of the record for which changes have to be discarded.

ZenodoManager$publishRecord(recordId)

recordId

the ID of the record to be published.

ZenodoManager$getFiles(recordId)

recordId

the ID of the record.

ZenodoManager$getFile(recordId, filename)

recordId

the ID of the record.

filename

filename

ZenodoManager$startFileUpload(path, recordId)

path

Local path of the file

recordId

ID of the record

ZenodoManager$completeFileUpload(path, recordId)

path

Local path of the file

recordId

ID of the record

ZenodoManager$uploadFile(path, record = NULL)

path

Local path of the file

record

object of classZenodoRecord

ZenodoManager$deleteFile(recordId, filename)

recordId

ID of the record

filename

name of the file to be deleted

ZenodoManager$getRecords(q = "", size = 10, all_versions = FALSE, exact = TRUE)

q

Elastic-Search-compliant query, as object of classcharacter. Default is ""

size

number of records to be retrieved per request (paginated). Default is 10

all_versions

object of classlogical indicating if all versions of records have to be retrieved. Default isFALSE

exact

object of classlogical indicating if exact matching has to be applied. Default isTRUE

quiet

object of classlogical indicating if logs have to skipped. Default isFALSE

ZenodoManager$getRecordByConceptDOI(conceptdoi)

conceptdoi

the concept DOI

ZenodoManager$getRecordByDOI(doi)

doi

the DOI

ZenodoManager$getRecordById(recid)

recid

the record ID

ZenodoManager$getRecordByConceptId(conceptrecid)

conceptrecid

the concept ID

ZenodoManager$getRequests(q = "", sort = "bestmatch", size = 10)

q

Search query used to filter results based on ElasticSearch's query string syntax. e.g. https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-query-string-query.html#query-string-syntax

sort

Sort search results. Built-in options are "bestmatch", "name", "newest", "oldest" (default: "bestmatch" or "newest").

size

number of records to be retrieved per request (paginated). Default is 10

ZenodoManager$getRequest(request_id)

request_id

the request ID

ZenodoManager$isActionableRequest(request_id)

request_id

the request ID

ZenodoManager$acceptRequest(request_id, message = NULL)

request_id

the request ID

message

optional message reason for acceptance

ZenodoManager$declineRequest(request_id, message = NULL)

request_id

the request ID

message

optional message reason for declination

ZenodoManager$cancelRequest(request_id, message = NULL)

request_id

the request ID

message

optional message reason for cancelation

ZenodoManager$clone(deep = FALSE)

deep

Whether to make a deep clone.

created

record creation date

updated

record update date

revision_id

revision id

is_draft

is draft

is_published

is published

status

record status

versions

versions

access

access policies

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

parent

parent record

pids

pids

stats

stats

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)

ZenodoRecord$getStats()

ZenodoRecord$getId()

ZenodoRecord$getParentId()

ZenodoRecord$getConceptId()

ZenodoRecord$setDOI(doi, provider = NULL, client = NULL)

doi

DOI to set for the record

provider

DOI provider

client

DOI client

ZenodoRecord$getDOI()

ZenodoRecord$getConceptDOI()

ZenodoRecord$setAccessPolicyRecord(access = c("public", "restricted"))

access

access policy ('public' or 'restricted')

ZenodoRecord$setAccessPolicyFiles(access = c("public", "restricted"))

access

access policy ('public' or 'restricted')

ZenodoRecord$setAccessPolicyEmbargo(active = FALSE, until = NULL, reason = "")

active

whether embargo is active or not. Default isFALSE

until

embargo date, object of classDate. Default isNULL. Must be provided if embargo is active

reason

embargo reason, object of classcharacter. Default is an empty string

ZenodoRecord$setResourceType(resourceType)

resourceType

record resource type

ZenodoRecord$setUploadType(uploadType)

uploadType

record upload type among the following values: 'publication', 'poster', 'presentation', 'dataset', 'image', 'video', 'software', 'lesson', 'physicalobject', 'other'

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'

ZenodoRecord$setImageType(imageType)

imageType

record publication type among the following values: 'figure','plot','drawing','diagram','photo', or 'other'

ZenodoRecord$setPublisher(publisher)

publisher

publisher object of classcharacter

ZenodoRecord$setPublicationDate(publicationDate)

publicationDate

object of classcharacter

ZenodoRecord$addDate(date, type, description = NULL)

date

date

type

type of date, among following values: 'accepted', 'available', 'collected', 'copyrighted', 'created', 'issued', 'other', 'submitted', 'updated', 'valid', 'withdrawn'

description

free text, specific information about the date

ZenodoRecord$removeDate(date, type)

date

the date to remove

type

the date type of the date to be removed

ZenodoRecord$setTitle(title)

title

object of classcharacter

ZenodoRecord$addAdditionalTitle(title, type, lang = "eng")

title

title free text

type

type of title, among following values: alternative-title, subtitle, translated-title, other

lang

language id

ZenodoRecord$removeAdditionalTitle(title, type, lang = "eng")

title

title free text

type

type of title, among following values: abstract, methods, series-information, table-of-contents, technical-info, other

lang

language id

ZenodoRecord$setDescription(description)

description

object of classcharacter

ZenodoRecord$addAdditionalDescription(description, type, lang = "eng")

description

description free text

type

type of description, among following values: abstract, methods, series-information, table-of-contents, technical-info, other

lang

language id

ZenodoRecord$removeAdditionalDescription(description, type, lang = "eng")

description

description free text

type

type of description, among following values: abstract, methods, series-information, table-of-contents, technical-info, other

lang

language id

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 isFALSE

type

type of person or org (creators/contributors)

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)

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 isFALSE

ZenodoRecord$removeCreatorByName(name)

name

creator name

ZenodoRecord$removeCreatorByAffiliation(affiliation)

affiliation

creator affiliation

ZenodoRecord$removeCreatorByORCID(orcid)

orcid

creator ORCID

ZenodoRecord$removeCreatorByGND(gnd)

gnd

creator GND

ZenodoRecord$removeCreatorByISNI(isni)

isni

creator ISNI

ZenodoRecord$removeCreatorByROR(ror)

ror

creator ROR

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 isFALSE

ZenodoRecord$removeContributorByName(name)

name

contributor name

ZenodoRecord$removeContributorByAffiliation(affiliation)

affiliation

contributor affiliation

ZenodoRecord$removeContributorByORCID(orcid)

orcid

contributor ORCID

ZenodoRecord$removeContributorByGND(gnd)

gnd

contributor GND

ZenodoRecord$removeContributorByISNI(isni)

isni

contributor ISNI

ZenodoRecord$removeContributorByROR(ror)

ror

contributor ROR

ZenodoRecord$addRight(  id = NULL,  title = NULL,  description = NULL,  link = NULL,  sandbox = FALSE)

id

license id

title

license title

description

a multi-lingual list

link

license link

sandbox

Use the Zenodo sandbox infrastructure as basis to control available licenses. Default isFALSE

ZenodoRecord$setLicense(licenseId, sandbox = FALSE)

licenseId

a license Id

sandbox

Use the Zenodo sandbox infrastructure as basis to control available licenses. Default isFALSE

ZenodoRecord$setVersion(version)

version

the record version to set

ZenodoRecord$addLanguage(language)

language

ISO 639-2 or 639-3 code

ZenodoRecord$setLanguage(language)

language

ISO 639-2 or 639-3 code

ZenodoRecord$addRelatedIdentifier(  identifier,  scheme,  relation_type,  resource_type = NULL)

identifier

identifier

scheme

scheme among following values: ark, arxiv, bibcode, doi, ean13, eissn, handle, igsn, isbn, issn, istc, lissn, lsid, pubmed id, purl, upc, url, urn, w3id

relation_type

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

resource_type

optional resource type

ZenodoRecord$removeRelatedIdentifier(identifier, scheme, relation_type)

identifier

identifier

scheme

scheme among following values: ark, arxiv, bibcode, doi, ean13, eissn, handle, igsn, isbn, issn, istc, lissn, lsid, pubmed id, purl, upc, url, urn, w3id

relation_type

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

ZenodoRecord$setReferences(references)

references

a vector or list of references to set for the record

ZenodoRecord$addReference(reference)

reference

the reference to add

ZenodoRecord$removeReference(reference)

reference

the reference to remove

ZenodoRecord$setSubjects(subjects)

subjects

a vector or list of subjects to set for the record

ZenodoRecord$setKeywords(keywords)

keywords

a vector or list of keywords to set for the record

ZenodoRecord$addSubject(subject)

subject

the subject to add

ZenodoRecord$addKeyword(keyword)

keyword

the keyword to add

ZenodoRecord$removeSubject(subject)

subject

the subject to remove

ZenodoRecord$removeKeyword(keyword)

keyword

the keyword to remove

ZenodoRecord$setNotes(notes)

notes

object of classcharacter

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

funder

funder id or name

grant

grant id or title

sandbox

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

ZenodoRecord$addGrant(grant, sandbox = FALSE)

grant

grant to add. The grant should be set with the id of the grant. If notrecognized by Zenodo, the function will return an warning only. The list of grants canfetched with theZenodoManager and the function$getAwards().

sandbox

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

ZenodoRecord$setGrants(grants, sandbox = FALSE)

grants

a vector or list of grants Values should among known grants The list of grants canfetched with theZenodoManager 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 isFALSE

ZenodoRecord$removeGrant(grant)

grant

grant to remove. The grant should be set with the Zenodo id of the grant

ZenodoRecord$setJournalTitle(title)

title

a title, object of classcharacter

ZenodoRecord$setJournalVolume(volume)

volume

a volume

ZenodoRecord$setJournalIssue(issue)

issue

an issue

ZenodoRecord$setJournalPages(pages)

pages

number of pages

ZenodoRecord$setConferenceTitle(title)

title

conference title, object of classcharacter

ZenodoRecord$setConferenceAcronym(acronym)

acronym

conference acronym, object of classcharacter

ZenodoRecord$setConferenceDates(dates)

dates

conference dates, object of classcharacter

ZenodoRecord$setConferencePlace(place)

place

conference place, object of classcharacter

ZenodoRecord$setConferenceUrl(url)

url

conference url, object of classcharacter

ZenodoRecord$setConferenceSession(session)

session

conference session, object of classcharacter

ZenodoRecord$setConferenceSessionPart(part)

part

conference session part, object of classcharacter

ZenodoRecord$setImprintPublisher(publisher)

publisher

the publisher, object of classcharacter

ZenodoRecord$setImprintISBN(isbn)

isbn

the ISBN, object of classcharacter

ZenodoRecord$setImprintPlace(place)

place

the place, object of classcharacter

ZenodoRecord$setPartofTitle(title)

title

the title, object of classcharacter

ZenodoRecord$setPartofPages(pages)

pages

the pages, object of classcharacter

ZenodoRecord$setThesisUniversity(university)

university

the university, object of classcharacter

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)

ZenodoRecord$removeThesisSupervisor(by, property)

by

property used as criterion to remove the thesis supervisor

property

property value used to remove the thesis supervisor

ZenodoRecord$removeThesisSupervisorByName(name)

name

thesis supervisor name

ZenodoRecord$removeThesisSupervisorByAffiliation(affiliation)

affiliation

thesis supervisor affiliation

ZenodoRecord$removeThesisSupervisorByORCID(orcid)

orcid

thesis supervisor ORCID

ZenodoRecord$removeThesisSupervisorByGND(gnd)

gnd

thesis supervisor GND

ZenodoRecord$addLocation(place, description = NULL, lat = NULL, lon = NULL)

place

place (required)

description

description

lat

latitude

lon

longitude

ZenodoRecord$removeLocation(place)

place

place (required)

ZenodoRecord$exportAs(format, filename, append_format = TRUE)

format

a valid Zenodo export format among the following: BibTeX, CSL, DataCite (or DataCiteXML), DublinCore, DCAT, JSON, JSON-LD, GeoJSON, MARCXML, DataCiteJSON, CodeMeta, DataPackage, CFF.

filename

the target filename (without extension)

append_format

wether format name has to be appended to the filename. Default isTRUE (forbackward compatibility reasons). Set it toFALSE if you want to use only thefilename.

ZenodoRecord$exportAsBibTeX(filename)

filename

the target filename (without extension)

ZenodoRecord$exportAsCSL(filename)

filename

the target filename (without extension)

ZenodoRecord$exportAsDataCite(filename)

filename

the target filename (without extension)

ZenodoRecord$exportAsDataCiteXML(filename)

filename

the target filename (without extension)

ZenodoRecord$exportAsDataCiteJSON(filename)

filename

the target filename (without extension)

ZenodoRecord$exportAsDublinCore(filename)

filename

the target filename (without extension)

ZenodoRecord$exportAsDCAT(filename)

filename

the target filename (without extension)

ZenodoRecord$exportAsJSON(filename)

filename

the target filename (without extension)

ZenodoRecord$exportAsJSONLD(filename)

filename

the target filename (without extension)

ZenodoRecord$exportAsGeoJSON(filename)

filename

the target filename (without extension)

ZenodoRecord$exportAsMARCXML(filename)

filename

the target filename (without extension)

ZenodoRecord$exportAsCodeMeta(filename)

filename

the target filename (without extension)

ZenodoRecord$exportAsCFF(filename)

filename

the target filename (without extension)

ZenodoRecord$exportAsDataPackage(filename)

filename

the target filename (without extension)

ZenodoRecord$exportAsAllFormats(filename)

filename

the target filename (without extension)

ZenodoRecord$getCitation(  style = c("havard-cite-them-right", "apa", "modern-language-association", "vancouver",    "chicago-fullnote-bibliography", "ieee", "bibtex"))

style

the style character string among. Possible values "havard-cite-them-right", "apa","modern-language-association","vancouver","chicago-fullnote-bibliography", "ieee", or "bibtex"

ZenodoRecord$listFiles(pretty = TRUE)

pretty

whether a pretty output (data.frame) should be returned (defaultTRUE), otherwisethe raw list of files is returned.

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 chosenparallel_handler. Default isFALSE

parallel_handler

The parallel handler to use eg.mclapply. To use a different parallel handler (such as egparLapply orparSapply), specify its function inparallel_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 withmakeClusterand passed ascl argument. After downloading all files, the cluster will be stopped automatically.

cl

an optional cluster for cluster-based parallel handlers

quiet

(default isFALSE) can be set to suppress informative messages (not warnings).

overwrite

(default isTRUE) can be set to FALSE to avoid re-downloading existing files.

timeout

(default is 60s) seedownload.file.

...

arguments inherited fromparallel::mclapply or the customparallel_handlercan be added (eg.mc.cores formclapply)

ZenodoRecord$print(..., format = "internal", depth = 1)

...

any other parameter. Not used

format

format to use for printing. By default,internal uses anzen4R internalprinting 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 formatfor 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

ZenodoRecord$toDCEntry()

ZenodoRecord$getFirstDOI()

ZenodoRecord$getLastDOI()

ZenodoRecord$getVersions()

ZenodoRecord$clone(deep = FALSE)

deep

Whether to make a deep clone.

ZenodoRequest$new(  url,  type,  request,  data = NULL,  file = NULL,  progress = FALSE,  accept = "application/vnd.inveniordm.v1+json",  token,  logger = NULL,  ...)

url

request URL

type

Type of request: 'GET', 'POST', 'PUT', 'DELETE'

request

the method request

data

payload (optional)

file

to be uploaded (optional)

progress

whether a progress status has to be displayed for download/upload

accept

accept header. Default is "application/vnd.inveniordm.v1+json"

token

user token

logger

the logger type

...

any other arg

ZenodoRequest$execute()

ZenodoRequest$getRequest()

ZenodoRequest$getRequestHeaders()

ZenodoRequest$getStatus()

ZenodoRequest$getResponse()

ZenodoRequest$getException()

ZenodoRequest$getResult()

ZenodoRequest$setResult(result)

result

result to be set

ZenodoRequest$clone(deep = FALSE)

deep

Whether to make a deep clone.

verbose.info

logger info status

verbose.debug

logger debug status

loggerType

Logger type, either "INFO", "DEBUG" or NULL (if no logger)

zen4RLogger$logger(type, text)

type

logger message type, "INFO", "WARN", or "ERROR"

text

log message

zen4RLogger$INFO(text)

text

log message

zen4RLogger$WARN(text)

text

log message

zen4RLogger$ERROR(text)

text

log message

zen4RLogger$new(logger = NULL)

logger

logger type NULL, 'INFO', or 'DEBUG'

zen4RLogger$getClassName()

zen4RLogger$getClass()

zen4RLogger$clone(deep = FALSE)

deep

Whether to make a deep clone.