[ADD] reference url for example report

ineelhere · Aug 12, 2024 · 7852bb8 · 7852bb8
1 parent b35c8cd
commit 7852bb8
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 0 deletions.
diff --git a/R/ctg_data_report.R b/R/ctg_data_report.R
@@ -5,6 +5,7 @@
 #' It automates the process of data analysis and visualization, providing insights into various
 #' aspects of clinical trials such as study status, enrollment, duration, and funding sources.
 #'
+#' Visit here for an example report - \url{https://ineelhere.github.io/clintrialx/report.html}.
 #' @param ctg_data A data frame containing clinical trial data. Required columns include:
 #'   \itemize{
 #'     \item \code{Study Status}: Current status of each study (e.g., \code{"Completed"}, \code{"Ongoing"})

diff --git a/README.Rmd b/README.Rmd
@@ -145,6 +145,8 @@ print(results)
 
 ## Trial Data HTML Reports
 *Currently works for data from ClinicalTrials.Gov*
+
+Visit here for an exqample report - https://ineelhere.github.io/clintrialx/report.html
 ```{r example6, eval = FALSE}
 #first get the data in a R dataframe
 my_clinical_trial_data <- ctg_bulk_fetch(condition="cancer")

diff --git a/README.md b/README.md
@@ -129,6 +129,9 @@ print(results)
 
 *Currently works for data from ClinicalTrials.Gov*
 
+Visit here for an exqample report -
+<https://ineelhere.github.io/clintrialx/report.html>
+
 ``` r
 #first get the data in a R dataframe
 my_clinical_trial_data <- ctg_bulk_fetch(condition="cancer")

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