Skip to content

Latest commit

 

History

History
64 lines (35 loc) · 3.55 KB

README.md

File metadata and controls

64 lines (35 loc) · 3.55 KB

tacmagic: PET Analysis in R

DOI Build Status Coverage status JOSS

To foster openness, replicability, and efficiency, tacmagic facilitates loading and analysis of positron emission tomography data in R.

As a tacmagic is a new package, we strongly recommend checking all work against existing analyses to confirm the results are as expected, and welcome any feedback.

Installation

The stable version of the package can be installed from CRAN, and the more recent development version can be installed with the devtools package.

Use the following R commands to download the version you would like: for the CRAN release, install.packages("tacmagic"), for the github release version that may not yet be available on CRAN, devtools::install_github("ropensci/tacmagic"), and for the very latest in-development version that is more likely to have bugs or errors and thus is not suitable for production use, use devtools::install_github("ropensci/tacmagic", ref="devel").

Features

The features of tacmagic are demonstrated in the package's walkthrough vignette, which is highly recommended for first-time uses.

Data loading and weighted-averages

Time-activity curve (TAC) and/or region of interest (ROI) volume data can be loaded from various file formats including PMOD .tac and .voistat files, a .mat file from the magia pipeline, and Turku PET Centre's .DFT format.

There is support for converting the radioactivity units in TAC data.

This package is not affiliated with any of the above pipelines.

Time-activity curve plotting

Basic plotting of one or more TAC from one or more participants is available.

Binding potential models

Non-invasive models are implemented including the standardized uptake volume (SUV), SUV ratio (SUVR), and the non-invasive Logan reference method.

Batch and group-wise analysis

Loading and analysis functions can be run as a batch or by individual participant.

Licence

Copyright (C) 2018 Eric E. Brown

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

We also note specifically that this package is not intended for clinical use, and may contain bugs or errors, so any results should be verified. As above, we provide no warranty and assume no liability.

Citation

Please cite this software package if you use it in your analyses.

Brown, E. E. (2019). tacmagic: PET Analysis in R. Journal of Open Source Software, 4(34), 1281. doi:10.21105/joss.01281.

ropensci_footer