R/set_app_input.R

In AdlCruz/rctexplorer: Explore Data From ClinicalTrials.gov

#' Set Input for Data Explorer
#'
#' This function takes a search expression and character vector with field names
#' and returns one dataframe.
#'
#' set_app_input()
#' @param search_expr A string following the querying guidelines at
#' https://clinicaltrials.gov/api/gui/ref/syntax and https://clinicaltrials.gov/api/gui/ref/expr
#' @param fields A character vector with field names. The explorer is optimised
#' to work with the default list 'for_explorer' found in package "rctapi".
#' @param max_studies A number indicating how many studies out of all that
#' match the search expression will be returned.
#' @keywords set app input
#' @export

set_app_input <- function (search_expr,
                           fields = for_explorer,
                           max_studies = 600) {

  df <- rctapi::get_study_fields(search_expr,fields, max_studies)

  # cleaning and transforming function
  df <- clean_app_input(df)

  df_key <- list(df = df,key = list(se = search_expr,n = nrow(df)))

  return(df_key)
}