From da231f7c49cee4199f52a0f0d4ae894cdcf25f42 Mon Sep 17 00:00:00 2001 From: rmgpanw Date: Sat, 22 Jun 2024 07:41:41 +0100 Subject: [PATCH] update get_subject() --- R/get_subject.R | 26 ++++++++++++++------------ man/get_subject.Rd | 13 +++++++------ 2 files changed, 21 insertions(+), 18 deletions(-) diff --git a/R/get_subject.R b/R/get_subject.R index ce78c72..403b95f 100644 --- 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 index c03d61c..db9f0de 100644 --- a/man/get_subject.Rd +++ b/man/get_subject.Rd @@ -37,16 +37,17 @@ causes", "Intermediate death", "Slow death".} A Tibble } \description{ -\itemize{ -\item This service returns information of subjects used in analyses from all datasets. -\item Results may be filtered by dataset ID, subject ID, sex, age bracket or Hardy Scale. -\item By default, this service queries the latest GTEx release. -} +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. \href{https://gtexportal.org/api/v2/redoc#tag/Datasets-Endpoints/operation/get_tissue_site_detail_api_v2_dataset_tissueSiteDetail_get}{GTEx Portal API documentation} } \examples{ -get_subject() +\dontrun{ + get_subject() +} } \seealso{ Other Datasets Endpoints: