R: Sort a directory of DICOM files into series

sortDicomDirectories {tractor.base}

R Documentation

Sort a directory of DICOM files into series

Description

This function sorts a directory containing DICOM files into subdirectories by series UID (DICOM tag 0x0020,0x000e), subject name (0x0010,0x0010) and/or scan date (0x0008,0x0020). Each unique identifier, together with its description for series, will be used as the name for a new subdirectory, and all relevant files will be copied into that subdirectory. Duplicate file names are disambiguated if necessary.

Usage

sortDicomDirectories(directories, method = c("internal", "divest"),
  deleteOriginals = FALSE, sortOn = "series", seriesId = c("UID",
  "number", "time"), nested = TRUE, ...)

Arguments

`directories`	A character vector giving the directories to search for DICOM files. Subdirectories will also be searched.
`method`	Character string specifying whether to use the internal DICOM reading code or use the `divest` package.
`deleteOriginals`	A single logical value. If `TRUE`, then the source files will be deleted after being copied to their new locations, making the operation a move rather than a copy. Nothing will be deleted if the copy fails.
`sortOn`	The string `"series"`, `"subject"` or `"date"`, or any combination in the order desired. This will be the basis of the sort, which will be nested if more than one type is specified.
`seriesId`	A string describing the kind of series identifier to use for sorting by series: `"UID"` (DICOM tag 0x0020,0x000e; the default), `"number"` (0x0020,0x0011) or `"time"` (0x0008,0x0031).
`nested`	Logical value. If `TRUE` and `directories` is of length 1, subdirectories will be created within the specified original directory. Otherwise they will be created in the working directory.
`...`	Additional arguments to pass to `readDicomFile`.

Value

This function is called for its side effect.

Author(s)

Jon Clayden

References

Please cite the following reference when using TractoR in your work:

J.D. Clayden, S. Muñoz Maniega, A.J. Storkey, M.D. King, M.E. Bastin & C.A. Clark (2011). TractoR: Magnetic resonance imaging and tractography with R. Journal of Statistical Software 44(8):1-18. doi:10.18637/jss.v044.i08.