Update examples and tests to ignore the return value from uploadDirec…

…tory.
ArtifactDB · Apr 22, 2024 · 30d6b0b · 30d6b0b
1 parent f1cc9ef
commit 30d6b0b
Show file tree

Hide file tree

Showing 35 changed files with 45 additions and 47 deletions.
diff --git a/R/approveProbation.R b/R/approveProbation.R
@@ -24,7 +24,7 @@
 #' # Mocking up an upload. 
 #' src <- allocateUploadDirectory(info$staging)
 #' write(file=file.path(src, "foo"), "BAR")
-#' res <- uploadDirectory("test", "probation", "v1", src, 
+#' uploadDirectory("test", "probation", "v1", src, 
 #'     staging=info$staging, url=info$url, probation=TRUE)
 #' fetchSummary("test", "probation", "v1", registry=info$registry)
 #'

diff --git a/R/cloneVersion.R b/R/cloneVersion.R
@@ -37,7 +37,7 @@
 #' # Mocking up an upload. 
 #' src <- allocateUploadDirectory(info$staging)
 #' write(file=file.path(src, "foo"), "BAR")
-#' res <- uploadDirectory("test", "simple", "v1", src, staging=info$staging, url=info$url)
+#' uploadDirectory("test", "simple", "v1", src, staging=info$staging, url=info$url)
 #'
 #' # Creating a clone.
 #' dest <- tempfile()

diff --git a/R/fetchDirectory.R b/R/fetchDirectory.R
@@ -31,7 +31,7 @@
 #' dir.create(file.path(src, "whee"))
 #' write(file=file.path(src, "whee", "blah"), "stuff")
 #' write(file=file.path(src, "whee2"), "more-stuff")
-#' res <- uploadDirectory("test", "simple", "v1", src, staging=info$staging, url=info$url)
+#' uploadDirectory("test", "simple", "v1", src, staging=info$staging, url=info$url)
 #'
 #' # Now fetching the directory.
 #' dir <- fetchDirectory("test/simple/v1", registry=info$registry, url=info$url)

diff --git a/R/fetchLatest.R b/R/fetchLatest.R
@@ -19,8 +19,8 @@
 #'
 #' # Mocking up a few uploads.
 #' src <- allocateUploadDirectory(info$staging)
-#' res <- uploadDirectory("test", "simple", "v1", src, staging=info$staging, url=info$url)
-#' res <- uploadDirectory("test", "simple", "v2", src, staging=info$staging, url=info$url)
+#' uploadDirectory("test", "simple", "v1", src, staging=info$staging, url=info$url)
+#' uploadDirectory("test", "simple", "v2", src, staging=info$staging, url=info$url)
 #'
 #' # Obtaining the latest version of this asset.
 #' fetchLatest("test", "simple", registry=info$registry, url=info$url)

diff --git a/R/fetchManifest.R b/R/fetchManifest.R
@@ -30,7 +30,7 @@
 #' write(file=file.path(src, "foo"), "BAR")
 #' dir.create(file.path(src, "whee"))
 #' write(file=file.path(src, "whee", "blah"), "stuff")
-#' res <- uploadDirectory("test", "simple", "v1", src, staging=info$staging, url=info$url)
+#' uploadDirectory("test", "simple", "v1", src, staging=info$staging, url=info$url)
 #'
 #' # Obtaining the manifest for this version.
 #' fetchManifest("test", "simple", "v1", registry=info$registry, url=info$url)

diff --git a/R/fetchSummary.R b/R/fetchSummary.R
@@ -24,7 +24,7 @@
 #' # Mocking up an upload. 
 #' src <- allocateUploadDirectory(info$staging)
 #' write(file=file.path(src, "foo"), "BAR")
-#' res <- uploadDirectory("test", "simple", "v1", src, staging=info$staging, url=info$url)
+#' uploadDirectory("test", "simple", "v1", src, staging=info$staging, url=info$url)
 #'
 #' # Obtain a summary for this version.
 #' fetchSummary("test", "simple", "v1", registry=info$registry, url=info$url)

diff --git a/R/fetchUsage.R b/R/fetchUsage.R
@@ -18,7 +18,7 @@
 #' src <- allocateUploadDirectory(info$staging)
 #' write(file=file.path(src, "foo"), "BAR")
 #' write(file=file.path(src, "whee"), "stuff")
-#' res <- uploadDirectory("test", "simple", "v1", src, staging=info$staging, url=info$url)
+#' uploadDirectory("test", "simple", "v1", src, staging=info$staging, url=info$url)
 #'
 #' # Obtaining the project usage.
 #' fetchUsage("test", registry=info$registry)

diff --git a/R/listFiles.R b/R/listFiles.R
@@ -27,7 +27,7 @@
 #' dir.create(file.path(src, "whee"))
 #' write(file=file.path(src, "whee", "blah"), "stuff")
 #' write(file=file.path(src, "whee2"), "more-stuff")
-#' res <- uploadDirectory("test", "simple", "v1", src, staging=info$staging, url=info$url)
+#' uploadDirectory("test", "simple", "v1", src, staging=info$staging, url=info$url)
 #'
 #' # List files, with or without a prefix.
 #' listFiles("test", "simple", "v1", registry=info$registry, url=info$url)

diff --git a/R/refreshUsage.R b/R/refreshUsage.R
@@ -21,7 +21,7 @@
 #' src <- allocateUploadDirectory(info$staging)
 #' write(file=file.path(src, "foo"), "BAR")
 #' write(file=file.path(src, "whee"), "stuff")
-#' res <- uploadDirectory("test", "simple", "v1", src, staging=info$staging, url=info$url)
+#' uploadDirectory("test", "simple", "v1", src, staging=info$staging, url=info$url)
 #'
 #' # Messing with the project usage:
 #' write(file=file.path(info$registry, "test", "..usage"), '{ "total": 0 }')

diff --git a/R/rejectProbation.R b/R/rejectProbation.R
@@ -24,7 +24,7 @@
 #' # Mocking up an upload. 
 #' src <- allocateUploadDirectory(info$staging)
 #' write(file=file.path(src, "foo"), "BAR")
-#' res <- uploadDirectory("test", "probation", "v1", src, 
+#' uploadDirectory("test", "probation", "v1", src, 
 #'     staging=info$staging, url=info$url, probation=TRUE)
 #' listVersions("test", "probation", registry=info$registry)
 #'

diff --git a/R/removeAsset.R b/R/removeAsset.R
@@ -21,7 +21,7 @@
 #' # Mocking up an asset so we have something to remove.
 #' src <- allocateUploadDirectory(info$staging)
 #' write(file=file.path(src, "foo"), "BAR")
-#' res <- uploadDirectory("test", "simple", "v1", src, staging=info$staging, url=info$url)
+#' uploadDirectory("test", "simple", "v1", src, staging=info$staging, url=info$url)
 #' listAssets("test", registry=info$registry)
 #'
 #' # Removing the asset.

diff --git a/R/removeVersion.R b/R/removeVersion.R
@@ -22,7 +22,7 @@
 #' # Mocking up a version if it doesn't already exist.
 #' src <- allocateUploadDirectory(info$staging)
 #' write(file=file.path(src, "foo"), "BAR")
-#' res <- uploadDirectory("test", "simple", "v1", src, staging=info$staging, url=info$url)
+#' uploadDirectory("test", "simple", "v1", src, staging=info$staging, url=info$url)
 #' listVersions("test", "simple", registry=info$registry)
 #'
 #' # Removing the version.

diff --git a/R/setPermissions.R b/R/setPermissions.R
@@ -30,7 +30,7 @@
 #' # Mocking up an upload. 
 #' src <- allocateUploadDirectory(info$staging)
 #' write(file=file.path(src, "foo"), "BAR")
-#' res <- uploadDirectory("test", "simple", "v1", src, staging=info$staging, url=info$url)
+#' uploadDirectory("test", "simple", "v1", src, staging=info$staging, url=info$url)
 #' fetchPermissions("test", registry=info$registry)
 #'
 #' # Setting them to something else.

diff --git a/R/uploadDirectory.R b/R/uploadDirectory.R
@@ -21,15 +21,14 @@
 #' src <- allocateUploadDirectory(info$staging)
 #' write(file=file.path(src, "foo"), "BAR")
 #'
-#' res <- uploadDirectory(
+#' uploadDirectory(
 #'     project="test", 
 #'     asset="simple", 
 #'     version="v1", 
 #'     directory=src, 
 #'     staging=info$staging,
 #'     url=info$url
 #' )
-#' res
 #'
 #' @seealso
 #' \code{\link{createProject}}, to create a new project for uploads.

diff --git a/man/approveProbation.Rd b/man/approveProbation.Rd
diff --git a/man/cloneVersion.Rd b/man/cloneVersion.Rd
diff --git a/man/fetchDirectory.Rd b/man/fetchDirectory.Rd
diff --git a/man/fetchLatest.Rd b/man/fetchLatest.Rd
diff --git a/man/fetchManifest.Rd b/man/fetchManifest.Rd
diff --git a/man/fetchSummary.Rd b/man/fetchSummary.Rd
diff --git a/man/fetchUsage.Rd b/man/fetchUsage.Rd
diff --git a/man/listFiles.Rd b/man/listFiles.Rd
diff --git a/man/refreshUsage.Rd b/man/refreshUsage.Rd
diff --git a/man/rejectProbation.Rd b/man/rejectProbation.Rd
diff --git a/man/removeAsset.Rd b/man/removeAsset.Rd
diff --git a/man/removeVersion.Rd b/man/removeVersion.Rd
diff --git a/man/setPermissions.Rd b/man/setPermissions.Rd
diff --git a/man/uploadDirectory.Rd b/man/uploadDirectory.Rd
diff --git a/tests/testthat/test-cloneVersion.R b/tests/testthat/test-cloneVersion.R
@@ -10,7 +10,7 @@ write(file=file.path(src, "foo"), "BAR")
 dir.create(file.path(src, "whee"))
 write(file=file.path(src, "whee", "blah"), "stuff")
 
-res <- uploadDirectory("test", "clone", "v1", src, staging=info$staging, url=info$url)
+uploadDirectory("test", "clone", "v1", src, staging=info$staging, url=info$url)
 
 test_that("cloneVersion works as expected with existing files", {
     dest <- tempfile()

diff --git a/tests/testthat/test-fetch.R b/tests/testthat/test-fetch.R
@@ -10,8 +10,8 @@ write(file=file.path(src, "foo"), "BAR")
 dir.create(file.path(src, "whee"))
 write(file=file.path(src, "whee", "blah"), "stuff")
 
-res <- uploadDirectory("test", "fetch", "v1", src, staging=info$staging, url=info$url)
-res <- uploadDirectory("test", "fetch", "v2", src, staging=info$staging, url=info$url)
+uploadDirectory("test", "fetch", "v1", src, staging=info$staging, url=info$url)
+uploadDirectory("test", "fetch", "v2", src, staging=info$staging, url=info$url)
 
 test_that("fetchManifest works as expected", {
     man <- fetchManifest("test", "fetch", "v1", registry=info$registry, url=info$url)

diff --git a/tests/testthat/test-latest.R b/tests/testthat/test-latest.R
@@ -6,11 +6,11 @@ removeProject("test", staging=info$staging, url=info$url)
 createProject("test", staging=info$staging, url=info$url)
 
 src <- allocateUploadDirectory(info$staging)
-res <- uploadDirectory("test", "latest", "v1", src, staging=info$staging, url=info$url)
+uploadDirectory("test", "latest", "v1", src, staging=info$staging, url=info$url)
 Sys.sleep(1.1) # force timestamps to be different for next versions.
-res <- uploadDirectory("test", "latest", "v2", src, staging=info$staging, url=info$url)
+uploadDirectory("test", "latest", "v2", src, staging=info$staging, url=info$url)
 Sys.sleep(1.1)
-res <- uploadDirectory("test", "latest", "v3", src, staging=info$staging, url=info$url)
+uploadDirectory("test", "latest", "v3", src, staging=info$staging, url=info$url)
 
 test_that("latest setting works as expected", {
     expect_identical(fetchLatest("test", "latest", registry=info$registry), "v3")

diff --git a/tests/testthat/test-list.R b/tests/testthat/test-list.R
@@ -13,10 +13,10 @@ dir.create(file.path(src, "whee"))
 write(file=file.path(src, "whee", "blah"), "stuff")
 write(file=file.path(src, "whee2"), LETTERS)
 
-res <- uploadDirectory("test", "list", "v1", src, staging=info$staging, url=info$url)
-res <- uploadDirectory("test", "list", "v2", src, staging=info$staging, url=info$url)
-res <- uploadDirectory("test", "more-list", version="foo", src, staging=info$staging, url=info$url)
-res <- uploadDirectory("more-list-test", "list", version="bar", src, staging=info$staging, url=info$url)
+uploadDirectory("test", "list", "v1", src, staging=info$staging, url=info$url)
+uploadDirectory("test", "list", "v2", src, staging=info$staging, url=info$url)
+uploadDirectory("test", "more-list", version="foo", src, staging=info$staging, url=info$url)
+uploadDirectory("more-list-test", "list", version="bar", src, staging=info$staging, url=info$url)
 
 test_that("listVersions works as expected", {
     versions <- listVersions("test", "list", registry=info$registry, url=info$url)

diff --git a/tests/testthat/test-probation.R b/tests/testthat/test-probation.R
@@ -8,8 +8,8 @@ createProject("test", staging=info$staging, url=info$url)
 # Mocking up an upload. 
 src <- allocateUploadDirectory(info$staging)
 write(file=file.path(src, "foo"), "BAR")
-res <- uploadDirectory("test", "probation", "good", src, staging=info$staging, url=info$url, probation=TRUE)
-res <- uploadDirectory("test", "probation", "bad", src, staging=info$staging, url=info$url, probation=TRUE)
+uploadDirectory("test", "probation", "good", src, staging=info$staging, url=info$url, probation=TRUE)
+uploadDirectory("test", "probation", "bad", src, staging=info$staging, url=info$url, probation=TRUE)
 
 test_that('probation approval works as expected', {
     expect_true(fetchSummary("test", "probation", "good", registry=info$registry)$on_probation)

diff --git a/tests/testthat/test-quota.R b/tests/testthat/test-quota.R
@@ -9,7 +9,7 @@ createProject("test-usage", info$staging, url=info$url)
 src <- allocateUploadDirectory(info$staging)
 write(file=file.path(src, "foo"), "BAR")
 write(file=file.path(src, "whee"), "stuff")
-res <- uploadDirectory("test-usage", "simple", "v1", src, staging=info$staging, url=info$url)
+uploadDirectory("test-usage", "simple", "v1", src, staging=info$staging, url=info$url)
 
 test_that("usage refreshment works as expected", {
     write(file=file.path(info$registry, "test-usage", "..usage"), '{ "total": 0 }')

diff --git a/tests/testthat/test-remove.R b/tests/testthat/test-remove.R
@@ -6,9 +6,9 @@ removeProject("test-R-remove", staging=info$staging, url=info$url)
 createProject("test-R-remove", staging=info$staging, url=info$url)
 
 src <- allocateUploadDirectory(info$staging)
-res <- uploadDirectory("test-R-remove", "sacrifice", "v1", src, staging=info$staging, url=info$url)
+uploadDirectory("test-R-remove", "sacrifice", "v1", src, staging=info$staging, url=info$url)
 Sys.sleep(1.1) # force timestamps to be different for next versions.
-res <- uploadDirectory("test-R-remove", "sacrifice", "v2", src, staging=info$staging, url=info$url)
+uploadDirectory("test-R-remove", "sacrifice", "v2", src, staging=info$staging, url=info$url)
 
 test_that("removal functions work as expected", {
     expect_true(file.exists(file.path(info$registry, "test-R-remove", "sacrifice", "v2")))