update get_subject()

rmgpanw · Jun 22, 2024 · da231f7 · da231f7
1 parent 0109dac
commit da231f7
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 18 deletions.
diff --git a/R/get_subject.R b/R/get_subject.R
@@ -1,20 +1,22 @@
-#'Get Subject
+#' Get Subject
 #'
-#'@description
-#' - This service returns information of subjects used in analyses from all datasets.
-#' - Results may be filtered by dataset ID, subject ID, sex, age bracket or Hardy Scale.
-#' - By default, this service queries the latest GTEx release.
+#' @description This service returns information of subjects used in analyses
+#' from all datasets. Results may be filtered by dataset ID, subject ID, sex,
+#' age bracket or Hardy Scale. By default, this service queries the latest GTEx
+#' release.
 #'
-#'[GTEx Portal API
-#'documentation](https://gtexportal.org/api/v2/redoc#tag/Datasets-Endpoints/operation/get_tissue_site_detail_api_v2_dataset_tissueSiteDetail_get)
+#' [GTEx Portal API
+#' documentation](https://gtexportal.org/api/v2/redoc#tag/Datasets-Endpoints/operation/get_tissue_site_detail_api_v2_dataset_tissueSiteDetail_get)
 #'
-#'@inheritParams gtexr_arguments
-#'@return A Tibble
-#'@export
-#'@family Datasets Endpoints
+#' @inheritParams gtexr_arguments
+#' @return A Tibble
+#' @export
+#' @family Datasets Endpoints
 #'
 #' @examples
-#' get_subject()
+#' \dontrun{
+#'   get_subject()
+#' }
 get_subject <- function(datasetId = "gtex_v8",
                         sex = NULL,
                         ageBrackets = NULL,

diff --git a/man/get_subject.Rd b/man/get_subject.Rd