pytrials 0.3.0

Python wrapper around the clinicaltrials.gov API

pytrials

Python wrapper around the clinicaltrials.gov API. Documentation for the API can be found here: https://clinicaltrials.gov/api/

• Free software: BSD license

• Documentation: https://pytrials.readthedocs.io.

Tutorial

To install:

$ pip install pytrials

Basic Usage

from pytrials.client import ClinicalTrials

ct = ClinicalTrials()

# Get 50 full studies related to Coronavirus and COVID in json format.
ct.get_full_studies(search_expr="Coronavirus+COVID", max_studies=50)

# Get the NCTId, Condition and Brief title fields from 500 studies related to Coronavirus and Covid, in csv format.
corona_fields = ct.get_study_fields(
    search_expr="Coronavirus+COVID",
    fields=["NCTId", "Condition", "BriefTitle"],
    max_studies=500,
    fmt="csv",
)

# Get the count of studies related to Coronavirus and COVID.
# ClinicalTrials limits API queries to 1000 records
# Count of studies may be useful to build loops when you want to retrieve more than 1000 records

ct.get_study_count(search_expr="Coronavirus+COVID")

# Read the csv data in Pandas
import pandas as pd

pd.DataFrame.from_records(corona_fields[1:], columns=corona_fields[0])

Credits

This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.

History

0.1.0 (2020-07-06)

• First release on PyPI.

0.1.2 (2020-07-11)

• Minor fixes

0.2.0 (2021-04-24)

• Improved test suite

• Added get_study_count function

0.2.1 (2023-07-09)

• Add classic prefix to url - #10

• Raise error if API status is not ok - #11

0.3.0 (2023-07-09)

• Add min_rnk option to get_study_fields - #12