Skip to content

Commit bc3ca40

Browse files
committed
update docs for 'deposit_add_resource'; ping @rkrug
1 parent 8d15bf0 commit bc3ca40

File tree

4 files changed

+13
-5
lines changed

4 files changed

+13
-5
lines changed

DESCRIPTION

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Package: deposits
22
Title: A universal client for depositing and accessing research data
33
anywhere
4-
Version: 0.2.1.051
4+
Version: 0.2.1.052
55
Authors@R:
66
person("Mark", "Padgham", , "[email protected]", role = c("aut", "cre"),
77
comment = c(ORCID = "0000-0003-2172-5265"))

R/client-main.R

+6-2
Original file line numberDiff line numberDiff line change
@@ -291,11 +291,15 @@ depositsClient <- R6::R6Class ( # nolint (not snake_case)
291291
},
292292

293293
# -----------
294-
# From here on, all methods are defined ain alphabetical order
294+
# From here on, all methods are defined in alphabetical order
295295
# ---------
296296

297297
#' @description Generate a local "datapackage.json" file, and/or add
298-
#' metadata from client.
298+
#' metadata from client. A "resource" must be readable by the
299+
#' \pkg{frictionless} package, generally meaning either a
300+
#' 'datapackage.json' file, or a rectangular structure able to be read
301+
#' and represented as a `data.frame`. See
302+
#' \url{https://docs.ropensci.org/frictionless/} for details.
299303
#' @param path Path to local resource to be added to client. May name an
300304
#' individual file or a directory.
301305
#' @return (Invisibly) Updated 'deposits' client

codemeta.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
"codeRepository": "https://github.com/ropenscilabs/deposits",
88
"issueTracker": "https://github.com/ropenscilabs/deposits/issues",
99
"license": "https://spdx.org/licenses/MIT",
10-
"version": "0.2.1.051",
10+
"version": "0.2.1.052",
1111
"programmingLanguage": {
1212
"@type": "ComputerLanguage",
1313
"name": "R",

man/depositsClient.Rd

+5-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)