update_file_metadata: Updates the file metadata of a given file

In QualitativeDataRepository/dvcurator: Curation Tools for Dataverse Repositories

Description

It will preserve all metadata that's not specifically addressed

Usage

update_file_metadata(
  file,
  label = NULL,
  directoryLabel = NULL,
  description = NULL,
  restricted = NULL,
  categories = NULL,
  key = Sys.getenv("DATAVERSE_KEY"),
  server = "data.qdr.syr.edu"
)

Arguments

file	The numeric ID of a file
label	A string. filename/label of the file.
directoryLabel	A string. The directory for the file _not_ starting with a slash
description	A string. The description of the file
restricted	Boolean. TRUE (for restricted), FALSE for not.
categories	A string. Tags for the file, comma or semicolon separated.
key	The API key for the dataverse installation
server	The dataverse installation to be used

Value

The API response (as text)

Examples

## Not run: 
# Updates the file description
update_message <- update_file_metadata(396501, description = "New file description")

## End(Not run)

QualitativeDataRepository/dvcurator documentation built on Nov. 8, 2021, 10 a.m.