Merge pull request #12 from aberHRML/devel

v0.6.1
aberHRML · Aug 18, 2021 · 3fb0d6a · 3fb0d6a
2 parents cbf332c + 83093e6
commit 3fb0d6a
Show file tree

Hide file tree

Showing 25 changed files with 92 additions and 27 deletions.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -1,9 +1,29 @@
 Package: metaboData
 Type: Package
 Title: Example Metabolomics Data Sets
-Version: 0.6.0
-Authors@R: person("Jasen", "Finch", email = "jsf9@aber.ac.uk", role = c("aut", "cre"))
-Description: Example metabolomics data sets from a variety of biological sample matrices, analysed using a number of mass spectrometrty based metabolomic analytical techniques.
+Version: 0.6.1
+Authors@R: c(
+    person("Jasen", "Finch", 
+        email = "jsf9@aber.ac.uk", 
+        role = c("aut", "cre"),
+        comment = c(ORCID = "0000-0002-6070-7476")
+    ),
+    person("Manfred", "Beckmann", 
+        email = "meb@aber.ac.uk", 
+        role = c("ctb")
+    ),
+    person("David", "Enot",
+        role = c("ctb")
+    ),
+    person("Wanchang", "Lin", 
+        role = c("ctb")
+    )
+    )
+Description: Example metabolomics data sets from a variety of biological sample matrices, 
+    analysed using a number of mass spectrometry based metabolomic analytical techniques.
+    The example data sets are stored remotely using GitHub releases 
+    <https://github.com/aberHRML/metaboData/releases> which can be accessed from R using the package.
+    The package also includes the 'abr1' FIE-MS data set from the FIEmspro package <https://users.aber.ac.uk/jhd/> <doi:10.1038/nprot.2007.511>.
 Depends: R (>= 3.4.0)
 Imports: 
     dplyr,

diff --git a/NEWS.md b/NEWS.md
@@ -1,3 +1,9 @@
+# metaboData 0.6.1
+
+* Added Manfred Beckmann, David Enot and Wanchang Lin as package contributors.
+
+* Added return values to the documentation of [`metaboData::downloadFiles()`](https://aberhrml.github.io/metaboData/reference/downloadFiles.html) and [`metaboData::downloadDataSet()`](https://aberhrml.github.io/metaboData/reference/downloadDataSet.html).
+
 # metaboData 0.6.0
 
 * Fix error caused when destination directory for data downloads does not exist.

diff --git a/R/download.R b/R/download.R
@@ -6,6 +6,7 @@
 #' @param internalDir stored the data set internally to the package installation location
 #' @param ask ask before downloading
 #' @param ... arguments to pass to \code{piggyback::pb_download()}
+#' @return A list object containing the API request response results for the downloaded files.
 #' @importFrom rlang is_interactive inform
 #' @importFrom dplyr group_by summarise filter
 #' @importFrom piggyback pb_download
@@ -82,6 +83,7 @@ downloadDataSet <- function(technique,
 #' @param internalDir stored the data set internally to the package installation location
 #' @param ask ask before downloading
 #' @param ... arguments to pass to \code{piggyback::pb_download()}
+#' @return A list object containing the API request response results for the downloaded files.
 #' @export
 #' @examples
 #' \dontrun{

diff --git a/docs/404.html b/docs/404.html
diff --git a/docs/LICENSE.html b/docs/LICENSE.html
diff --git a/docs/articles/index.html b/docs/articles/index.html
diff --git a/docs/articles/metaboData.html b/docs/articles/metaboData.html
diff --git a/docs/authors.html b/docs/authors.html
diff --git a/docs/index.html b/docs/index.html
diff --git a/docs/news/index.html b/docs/news/index.html
diff --git a/docs/pkgdown.yml b/docs/pkgdown.yml
@@ -3,7 +3,7 @@ pkgdown: 1.6.1
 pkgdown_sha: ~
 articles:
   metaboData: metaboData.html
-last_built: 2021-08-13T14:43Z
+last_built: 2021-08-18T16:15Z
 urls:
   reference: https://aberHRML.github.io/metaboData//reference
   article: https://aberHRML.github.io/metaboData//articles

diff --git a/docs/reference/abr1.html b/docs/reference/abr1.html
diff --git a/docs/reference/availableDataSets.html b/docs/reference/availableDataSets.html
diff --git a/docs/reference/availableFiles.html b/docs/reference/availableFiles.html
diff --git a/docs/reference/dataSets.html b/docs/reference/dataSets.html
diff --git a/docs/reference/description.html b/docs/reference/description.html
diff --git a/docs/reference/downloadDataSet.html b/docs/reference/downloadDataSet.html
diff --git a/docs/reference/downloadFiles.html b/docs/reference/downloadFiles.html
diff --git a/docs/reference/filePaths.html b/docs/reference/filePaths.html
diff --git a/docs/reference/index.html b/docs/reference/index.html
diff --git a/docs/reference/reexports.html b/docs/reference/reexports.html
diff --git a/docs/reference/runinfo.html b/docs/reference/runinfo.html
diff --git a/docs/reference/techniques.html b/docs/reference/techniques.html
diff --git a/man/downloadDataSet.Rd b/man/downloadDataSet.Rd
diff --git a/man/downloadFiles.Rd b/man/downloadFiles.Rd