Skip to content

Commit

Permalink
[CRAN MOD] note adjustments
Browse files Browse the repository at this point in the history
  • Loading branch information
ineelhere committed Aug 22, 2024
1 parent d3d7d8b commit b866f6e
Show file tree
Hide file tree
Showing 6 changed files with 271 additions and 22 deletions.
4 changes: 1 addition & 3 deletions DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Authors@R:
person("Indraneel", "Chakraborty",, "hello.indraneel@gmail.com",
role = c("aut", "cre"), comment = c(ORCID = "0000-0001-6958-8269"))
Maintainer: Indraneel Chakraborty <hello.indraneel@gmail.com>
Description: Are you spending too much time fetching and managing clinical trial data? Struggling with complex queries and bulk data extraction? What if you could simplify this process with just a few lines of code? Introducing clintrialx - Fetch clinical trial data from sources like ClinicalTrials.gov and the CTTI AACT database with R, supporting pagination and bulk downloads. Also, you can generate HTML reports based on the data obtained from the sources!
Description: Are you spending too much time fetching and managing clinical trial data? Struggling with complex queries and bulk data extraction? What if you could simplify this process with just a few lines of code? Introducing clintrialx - Fetch clinical trial data from sources like ClinicalTrials.gov and the Clinical Trials Transformation Initiative - Access to Aggregate Content of ClinicalTrials.gov database with R, supporting pagination and bulk downloads. Also, you can generate HTML reports based on the data obtained from the sources!
License: Apache License 2.0 | file LICENSE
Encoding: UTF-8
LazyData: true
Expand All @@ -27,5 +27,3 @@ Suggests:
VignetteBuilder: knitr
RoxygenNote: 7.3.2
URL: http://www.indraneelchakraborty.com/clintrialx/
ExtraLicense: LICENSE
ExtraFiles: CODE_OF_CONDUCT.md, logo.png
4 changes: 2 additions & 2 deletions R/ctg_data_report.R
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@
#' }
#'
#' @seealso
#' \url{https://www.indraneelchakraborty.com/clintrialx} for more information about the ClinTrialX package.
#' \url{https://www.indraneelchakraborty.com/clintrialx/} for more information about the ClinTrialX package.
#' @importFrom grDevices colorRampPalette
#' @importFrom utils install.packages installed.packages
#' @importFrom rmarkdown render
Expand Down Expand Up @@ -200,7 +200,7 @@ ctg_data_report <- function(ctg_data,
footer_content <- if (!is.null(custom_footer)) {
paste0('\n\n<div class="footer">\n', custom_footer, '\n</div>\n')
} else {
'\n\n<div class="footer">\nAutomated report generated using <a href="https://www.indraneelchakraborty.com/clintrialx">ClinTrialX</a> package\n</div>\n'
'\n\n<div class="footer">\nAutomated report generated using <a href="https://www.indraneelchakraborty.com/clintrialx/">ClinTrialX</a> package\n</div>\n'
}

# Write the Rmd content dynamically
Expand Down
31 changes: 21 additions & 10 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ knitr::opts_chunk$set(

[![R-CMD-check](https://github.com/ineelhere/clintrialx/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/ineelhere/clintrialx/actions/workflows/R-CMD-check.yaml)
[![License:
Apache-2.0](https://img.shields.io/badge/license-Apache--2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
Apache-2.0](https://img.shields.io/badge/license-Apache--2.0-blue.svg)](https://opensource.org/license/apache-2-0)
[![pkgdown](https://img.shields.io/badge/pkgdown-docs-blue.svg)](https://www.indraneelchakraborty.com/clintrialx/)
[![Visitors](https://api.visitorbadge.io/api/visitors?path=https%3A%2F%2Fgithub.com%2Fineelhere%2Fclintrialx&label=Visitors&labelColor=%23f47373&countColor=%2337d67a&style=flat&labelStyle=upper)](https://github.com/ineelhere/clintrialx)

Expand Down Expand Up @@ -113,7 +113,7 @@ ctg_get_fields(
```
#### Based on fileds - Bulk download
#### Based on fields - Bulk download
Download all available data for your query. No limits!
Expand Down Expand Up @@ -144,9 +144,12 @@ print(results)
```
## Trial Data HTML Reports
*Currently works for data from ClinicalTrials.Gov*
Visit here for an exqample report - https://www.indraneelchakraborty.com/clintrialx/report.html
Visit here for an exqample report -
<https://www.indraneelchakraborty.com/clintrialx/report.html>
```{r example6, eval = FALSE}
#first get the data in a R dataframe
my_clinical_trial_data <- ctg_bulk_fetch(condition="cancer")
Expand All @@ -164,7 +167,9 @@ ctg_data_report(
)
```
Check the path `reports/clinical_trials.html` on your local. It will have the html report file.
Check the path `reports/clinical_trials.html` on your local. It will
have the html report file.
Cool stuff - It also has the codes to the plots!
Expand All @@ -180,13 +185,19 @@ version_info(source = "clinicaltrials.gov")
## Get Involved
🚀 **Ready to contribute?** Lets make`clintrialx` even better.
Check out the [contributing guidelines](https://github.com/ineelhere/clintrialx/blob/main/CONTRIBUTING.md)
to get started.
🚀 Ready to contribute? Let's make clintrialx even better!

- Fork the [GitHub](https://github.com/ineelhere/clintrialx) repo.
- Check out your development branch from the dev branch.
- Do your work on a feature (ftr) branch.
- Raise a PR against the dev branch of the [clintrialx](https://github.com/ineelhere/clintrialx) repo.
- Sit back and [relax](https://www.youtube.com/watch?v=Uffjii1hXzU) while I review it!

💬 **Questions or Feedback?** Feel free to open an issue on [GitHub Issues page](https://github.com/ineelhere/clintrialx/issues).
💬 **Questions or Feedback?** Feel free to open an issue on [GitHub
Issues page](https://github.com/ineelhere/clintrialx/issues).

🌟 **Enjoying `clintrialx`?** Please consider giving it a star on [GitHub](https://github.com/ineelhere/clintrialx)! Your support helps this project
grow and improve.
🌟 **Enjoying `clintrialx`?** Please consider giving it a star on
[GitHub](https://github.com/ineelhere/clintrialx)! Your support helps
this project grow and improve.

More updates to come. Happy coding! 🎉
17 changes: 11 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

[![R-CMD-check](https://github.com/ineelhere/clintrialx/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/ineelhere/clintrialx/actions/workflows/R-CMD-check.yaml)
[![License:
Apache-2.0](https://img.shields.io/badge/license-Apache--2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
Apache-2.0](https://img.shields.io/badge/license-Apache--2.0-blue.svg)](https://opensource.org/license/apache-2-0)
[![pkgdown](https://img.shields.io/badge/pkgdown-docs-blue.svg)](https://www.indraneelchakraborty.com/clintrialx/)
[![Visitors](https://api.visitorbadge.io/api/visitors?path=https%3A%2F%2Fgithub.com%2Fineelhere%2Fclintrialx&label=Visitors&labelColor=%23f47373&countColor=%2337d67a&style=flat&labelStyle=upper)](https://github.com/ineelhere/clintrialx)

Expand Down Expand Up @@ -95,7 +95,7 @@ ctg_get_fields(
)
```

#### Based on fileds - Bulk download
#### Based on fields - Bulk download

Download all available data for your query. No limits!

Expand Down Expand Up @@ -164,10 +164,15 @@ version_info(source = "clinicaltrials.gov")

## Get Involved

🚀 **Ready to contribute?** Lets make`clintrialx` even better. Check out
the [contributing
guidelines](https://github.com/ineelhere/clintrialx/blob/main/CONTRIBUTING.md)
to get started.
🚀 Ready to contribute? Let’s make clintrialx even better!

- Fork the [GitHub](https://github.com/ineelhere/clintrialx) repo.
- Check out your development branch from the dev branch.
- Do your work on a feature (ftr) branch.
- Raise a PR against the dev branch of the
[clintrialx](https://github.com/ineelhere/clintrialx) repo.
- Sit back and [relax](https://www.youtube.com/watch?v=Uffjii1hXzU)
while I review it!

💬 **Questions or Feedback?** Feel free to open an issue on [GitHub
Issues page](https://github.com/ineelhere/clintrialx/issues).
Expand Down
2 changes: 1 addition & 1 deletion man/ctg_data_report.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit b866f6e

Please sign in to comment.