fs_update: Update article title, description, or type

In rfigshare: An R Interface to 'figshare'

Update article title, description, or type

Description

Updates the article title, description or type. If any is not specified, it will remain unchanged.

Usage

fs_update(
  article_id,
  title = NA,
  description = NA,
  type = NA,
  mine = TRUE,
  session = fs_get_auth(),
  debug = FALSE
)

Arguments

article_id	the id number of the article
title	for the article (to replace original title)
description	of the article (replaces original designation)
type	one of: dataset, figure, media, poster, or paper (replaces original designation)
mine	Set to TRUE if it refers to an item on your own account
session	(optional) the authentication credentials from fs_auth.
debug	return httr PUT request visibly?

Details

Updates the title, description, and type of an article.

Value

output of PUT request (invisibly)

Author(s)

Carl Boettiger [e-mail]

References

https://docs.figshare.com

See Also

fs_auth, fs_add_tags

Examples

## Not run: 
fs_update(138, title = "New title") 

## End(Not run)

rfigshare documentation built on May 10, 2022, 1:05 a.m.