Skip to content

Commit

Permalink
README tweaks
Browse files Browse the repository at this point in the history
  • Loading branch information
jonclayden committed Apr 2, 2021
1 parent a72cfa8 commit 1150578
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 8 deletions.
4 changes: 2 additions & 2 deletions README.Rmd
Expand Up @@ -2,7 +2,7 @@
knitr::opts_chunk$set(collapse = TRUE)
```

[![CRAN version](http://www.r-pkg.org/badges/version/divest)](https://cran.r-project.org/package=divest) [![Build Status](https://travis-ci.org/jonclayden/divest.svg?branch=master)](https://travis-ci.org/jonclayden/divest) [![Build status](https://ci.appveyor.com/api/projects/status/lc8v02uc1ywkskrc?svg=true)](https://ci.appveyor.com/project/jonclayden/divest) [![Coverage Status](https://coveralls.io/repos/github/jonclayden/divest/badge.svg?branch=master)](https://coveralls.io/github/jonclayden/divest?branch=master) [![Dependencies](https://tinyverse.netlify.com/badge/divest)](https://tinyverse.netlify.app)
[![CRAN version](http://www.r-pkg.org/badges/version/divest)](https://cran.r-project.org/package=divest) [![CI Status](https://github.com/jonclayden/divest/actions/workflows/ci.yaml/badge.svg)](https://github.com/jonclayden/divest/actions/workflows/ci.yaml) [![Coverage Status](https://coveralls.io/repos/github/jonclayden/divest/badge.svg?branch=master)](https://coveralls.io/github/jonclayden/divest?branch=master) [![Dependencies](https://tinyverse.netlify.com/badge/divest)](https://tinyverse.netlify.app)

# An R interface to dcm2niix

Expand All @@ -25,7 +25,7 @@ remotes::install_github("jonclayden/divest")

The package's key function is `readDicom`, which scans a directory containing DICOM files, stacks related data into merged 3D or 4D images where appropriate, and returns a list of `niftiImage` objects. For example,

```{r}
```{r, results="hide"}
library(divest)
path <- system.file("extdata", "raw", package="divest")
images <- readDicom(path, interactive=FALSE, verbosity=-1)
Expand Down
12 changes: 6 additions & 6 deletions README.md
@@ -1,6 +1,6 @@


[![CRAN version](http://www.r-pkg.org/badges/version/divest)](https://cran.r-project.org/package=divest) [![Build Status](https://travis-ci.org/jonclayden/divest.svg?branch=master)](https://travis-ci.org/jonclayden/divest) [![Build status](https://ci.appveyor.com/api/projects/status/lc8v02uc1ywkskrc?svg=true)](https://ci.appveyor.com/project/jonclayden/divest) [![Coverage Status](https://coveralls.io/repos/github/jonclayden/divest/badge.svg?branch=master)](https://coveralls.io/github/jonclayden/divest?branch=master) [![Dependencies](https://tinyverse.netlify.com/badge/divest)](https://tinyverse.netlify.app)
[![CRAN version](http://www.r-pkg.org/badges/version/divest)](https://cran.r-project.org/package=divest) [![CI Status](https://github.com/jonclayden/divest/actions/workflows/ci.yaml/badge.svg)](https://github.com/jonclayden/divest/actions/workflows/ci.yaml) [![Coverage Status](https://coveralls.io/repos/github/jonclayden/divest/badge.svg?branch=master)](https://coveralls.io/github/jonclayden/divest?branch=master) [![Dependencies](https://tinyverse.netlify.com/badge/divest)](https://tinyverse.netlify.app)

# An R interface to dcm2niix

Expand Down Expand Up @@ -29,10 +29,6 @@ The package's key function is `readDicom`, which scans a directory containing DI
library(divest)
path <- system.file("extdata", "raw", package="divest")
images <- readDicom(path, interactive=FALSE, verbosity=-1)
## [dcm2niix WARNING] Unable to determine manufacturer (0008,0070), so conversion is not tuned for vendor.
## [dcm2niix WARNING] All images appear to be a single slice - please check slice/vector orientation
## [dcm2niix WARNING] Check that 2D images are not mirrored.
## [dcm2niix WARNING] Unable to determine manufacturer (0008,0070), so conversion is not tuned for vendor.
```

The conversion is interactive by default, prompting the user to select which series to convert, but here we simply convert everything non-interactively. The minimal test dataset provided with the package contains two images from each of two acquisitions. (It is incomplete, hence the warnings.) We can see the basic properties of a converted composite image by printing it.
Expand Down Expand Up @@ -62,7 +58,7 @@ attributes(images[[i]])
## [1] "mm" "s"
##
## $.nifti_image_ptr
## <pointer: 0x7fc594ce4f30>
## <pointer: 0x125ea32b0>
##
## $.nifti_image_ver
## [1] 1
Expand Down Expand Up @@ -177,6 +173,10 @@ It is also possible to obtain information about the available DICOM series witho
```r
names(scanDicom(path))
## [dcm2niix info] Found 4 DICOM file(s)
## [dcm2niix WARNING] Unknown manufacturer
## [dcm2niix WARNING] Unknown manufacturer
## [dcm2niix WARNING] Unknown manufacturer
## [dcm2niix WARNING] Unknown manufacturer
## [1] "label" "rootPath" "files"
## [4] "seriesNumber" "seriesDescription" "patientName"
## [7] "studyDate" "echoTime" "repetitionTime"
Expand Down

0 comments on commit 1150578

Please sign in to comment.