Add more description to value fields of exported functions.

R/allphenotypes.R

@@ -11,12 +11,12 @@
 #' can take multiple values, so the other columns id, characteristic, and
 #' number_of_users are replicated in the data.frame. Default: `FALSE`
 #' @param ... Curl options passed on to [crul::HttpClient]
-#' @return data.frame of results, or list if `df=FALSE`
+#' @return data.frame of openSNP phenotypes, variants and users per phenotype, or list if `df=FALSE`
 #' @examples \dontrun{
 #' # Get all data
 #' allphenotypes(df = TRUE)
 #'
-#' # Output a list, then call the characterisitc of interest by 'id' or
+#' # Output a list, then call the characteristic of interest by 'id' or
 #' # 'characteristic'
 #' datalist <- allphenotypes()
 #' names(datalist) # get list of all characteristics you can call

R/annotations.R

@@ -12,7 +12,7 @@
 #' 		are: 'plos', 'mendeley', 'snpedia', 'metadata'). 'metadata' gives the
 #' 		metadata for the response.
 #' @param ... Curl options passed on to [crul::HttpClient]
-#' @return data.frame of results
+#' @return data.frame of openSNP phenotypes from specified source
 #' @examples \dontrun{
 #' # Get all data
 #' ## get just the metadata

R/download_users.R

@@ -64,7 +64,7 @@ get_write <- function(x, y, ...) {
 #' written in the function download_users, and then searches against those
 #' variables for the path to the file saved. Alternatively, you can supply
 #' the path.
-#' @return A data.frame.
+#' @return A data.frame with openSNP user files retrieved from local storage
 #' @examples \dontrun{
 #' dat <- read_users(name = "kevinmcc")
 #' head(dat)

R/phenotypes.R

@@ -5,7 +5,7 @@
 #' @param userid ID of openSNP user.
 #' @param df Return data.frame (`TRUE`) or not (`FALSE`). Default: `FALSE`
 #' @param ... Curl options passed on to [crul::HttpClient]
-#' @return List of phenotypes for specified user(s).
+#' @return List of phenotypes for specified user(s) from openSNP.
 #'
 #' @examples \dontrun{
 #' phenotypes(userid = 1)

R/phenotypes_byid.R

@@ -7,7 +7,7 @@
 #' @param return_ Return data.frame (`TRUE`) or not (`FALSE`). Default: `FALSE`
 #' @param ... Curl options passed on to [crul::HttpClient]
 #' @return List of description of phenotype, list of known variants, or
-#' data.frame of variants for each user with that phenotype.
+#' data.frame of variants for each user with that phenotype retrieved from openSNP.
 #'
 #' @examples \dontrun{
 #' phenotypes_byid(phenotypeid = 12, return_ = "desc")

R/users.R

@@ -4,7 +4,7 @@
 #' @family opensnp-fxns
 #' @param df Return data.frame (`TRUE`) or not (`FALSE`). Default: `FALSE`
 #' @param ... Curl options passed on to [crul::HttpClient]
-#' @return List of openSNP users, their ID numbers, and XX if available.
+#' @return List of openSNP users, their ID numbers, and genome data if available.
 #' @examples \dontrun{
 #' # just the list
 #' data <- users(df = FALSE)