diff --git a/README.md b/README.md index 543ad48..856fa97 100644 --- a/README.md +++ b/README.md @@ -14,19 +14,17 @@ ![GitHub milestone details](https://img.shields.io/github/milestones/progress-percent/jjjermiah/nbia-toolkit/1?style=flat-square&label=1.0.0%20Stable%20Release%20Milestone&link=https%3A%2F%2Fgithub.com%2Fjjjermiah%2Fnbia-toolkit%2Fmilestone%2F1)![GitHub milestone details](https://img.shields.io/github/milestones/progress/jjjermiah/nbia-toolkit/1?style=flat-square&label=%20&link=https%3A%2F%2Fgithub.com%2Fjjjermiah%2Fnbia-toolkit%2Fmilestone%2F1) - - -`nbiatoolkit` is a python package that provides programmatic access to query and download images from the National Biomedical Imaging Archive (**NBIA**) and The Cancer Imaging Archive (**TCIA**) databases. +#### A python package that provides programmatic access to query and download images from the National Biomedical Imaging Archive (**NBIA**) and The Cancer Imaging Archive (**TCIA**) databases. ## Features +> [!TIP] +> For a thorough description of the package and its available features, please refer to the Documentation at [NBIA-Toolkit Read The Docs](https://nbia-toolkit.readthedocs.io/en/latest/) - Use NBIA Guest account to access public data OR authenticate using OAuth with user credentials for limited access data (requires approved data access). - ***Query NBIA database*** for metadata on ***collections***, ***patients***, ***studies***, ***series***, and ***images*** - Download images from NBIA - ***Validate doownloads with MD5 checksums*** for downloaded images - **Auto-sort** DICOM files using a user-defined pattern of DICOM tags with specialized ***DICOMSorter class*** -> [!NOTE] -> For a thorough description of the package and its available features, please refer to the Documentation at [NBIA-Toolkit Read The Docs](https://nbia-toolkit.readthedocs.io/en/latest/) ## Installation