knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-",
  out.width = "100%"
)

Travis build status AppVeyor build status Coverage status

costumer

The goal of costumer is to provide the data, the functions, scripts for the analyses and the documentation (report) within the relative templates for the paper Building Comprehensive Searches including PubMed and ClinicalTrials.gov Through a Machine Learning Approach for Systematic Reviews. @lanera18

Installation

You can install the development version from GitHub with the following procedure:

## If you do not have the `devtools` package installed, please install it
# install.packages("devtools")
devtools::install_github("UBESP-DCTV/costumer")

folders' organization

Note: the main data used are too huge to be included in an R package or in a GitHub repository. Here you can find a folder named non_git_nor_build_derived_data/ (2.86 GB) which contains:

  • 171106-all_svm_3565/ folder with all the outputs of the last analyses:
    • CV-Plots/ folder which contains all the cross-validation plots representing the decision levels for the tuning parameter used in each model;
    • models/ folder which contains all the trained models;
    • hutch3.rda data which contains the hutch3 data frame containing all the data-step of the analyses, i.e., starting data, preprocessed data, DMT, testing, data, the model used, plots provided, ... everything!
    • *.txt log files.
  • raw_pubmed/ folder with the data used to train the models, which are needed to run the script data-raw/import_pubmed.R. Hence, if you would like to run that script by yourself you need to put this folder as it is into the data-raw/ one.
  • raw_ctgov.zip zip file with the data used to test the models, i.e., the clinicaltrial.gov snapshot used and which is (when unzipped) needed to run the script data-raw/import_ctgov.R. Hence, if you would like to run that script by yourself you need to unzip this file and put the output folder as it is (~841 MB) into the data-raw/ one.
  • random4h28.xlsx file with the sample data used to (automated) test functions provided with the package, which is needed to run the script data-raw/import_liu.R. Hence, if you would like to run that script by yourself you need to put this file as it is into the data-raw/ folder.
  • summaries_*.rda the outputs ready-to-use of the functions import_*.R which are needed to run the script of the analyses. Hence, if you would like to run that script by yourself you need to put this files as they are into the data/ folder.
  • test_*.rda data which are the outputs of the function data-raw/ct_corpus_and_dtm.R which are also needed (and here are ready-to-use) to run the script of the analyses. Hence, if you would like to run that script by yourself, you need to put this files as they are into the data/ folder.

Bug reports

If you encounter a bug, please file a reprex (minimal reproducible example) to

Reference



UBESP-DCTV/costumer documentation built on Feb. 1, 2023, 4:52 a.m.