Skip to content

Commit c246556

Browse files
author
ncullen93
committed
ENH: R code follows consistant style guide
1 parent 063b0a8 commit c246556

File tree

238 files changed

+17707
-15884
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

238 files changed

+17707
-15884
lines changed

R/aaa_data.R

+41-39
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
1-
21
#' DesikanKillianyTourville
3-
#'
4-
#' A data frame label numbers and names for the neuroanatomical
2+
#'
3+
#' A data frame label numbers and names for the neuroanatomical
54
#' DesikanKillianyTourville labels.
6-
#'
5+
#'
76
#' @docType data
87
#' @references \url{http://www.ncbi.nlm.nih.gov/pubmed/23227001}
98
#' @format A data frame listing the following variables.
@@ -16,26 +15,26 @@
1615
#' \item{\code{hemisphere}}{ left or right hemisphere. }
1716
#' }
1817
#' @examples
19-
#' data(DesikanKillianyTourville)
18+
#' data(DesikanKillianyTourville)
2019
"DesikanKillianyTourville"
2120

2221
#' BOLD Correlation Matrix
23-
#'
22+
#'
2423
#' A data frame with an example square BOLD correlation matrix.
25-
#'
24+
#'
2625
#' @docType data
27-
#'
28-
#' @format A data frame square correlation matrix listed by AAL
26+
#'
27+
#' @format A data frame square correlation matrix listed by AAL
2928
#' anatomical column names.
3029
#' @references \url{http://en.wikipedia.org/wiki/Automated_Anatomical_Labeling}
31-
#' @examples
30+
#' @examples
3231
#' data(bold_correlation_matrix)
3332
"bold_correlation_matrix"
3433

3534
#' @title powers_areal_mni_itk
3635
#' @docType data
37-
#' @description A data frame providing coordinates for the nodes
38-
#' identified by Powers at al. Coordinates have been modified from nifti
36+
#' @description A data frame providing coordinates for the nodes
37+
#' identified by Powers at al. Coordinates have been modified from nifti
3938
#' space to ITK space
4039
#' @format A data frame listing the following variables.
4140
#' \describe{
@@ -49,43 +48,46 @@
4948
#' \item{\code{r}}{ red value for system }
5049
#' \item{\code{g}}{ green value for system }
5150
#' \item{\code{b}}{ blue value for system }
52-
#' \item{\code{Anatomy}}{ anatomical location as
51+
#' \item{\code{Anatomy}}{ anatomical location as
5352
#' determined by OASIS labeling }
5453
#' \item{\code{Lobe}}{ lobe location of node }
5554
#' \item{\code{Brodmann}}{ Broadmann area number }
5655
#' \item{\code{AAL}}{ AAL region label }
5756
#' }
5857
#' #' @references \url{http://www.nil.wustl.edu/labs/petersen/Resources.html}
59-
#'
60-
#' @examples
58+
#'
59+
#' @examples
6160
#' data(powers_areal_mni_itk)
6261
#' \dontrun{
63-
#' fixed <- antsImageRead( getANTsRData("ch2") )
64-
#' moving <- antsImageRead( getANTsRData("mni") )
65-
#' mytx <- antsRegistration( fixed=fixed, moving=moving,
66-
#' typeofTransform = c("SyN") )
67-
#' data( "powers_areal_mni_itk", package = "ANTsR", envir = environment() )
68-
#' coords = powers_areal_mni_itk[,1:3]
69-
#' ch2reg = antsRegistration( fixed, moving, typeofTransform = "SyN" )
70-
#' coordsw <- antsApplyTransformsToPoints(
71-
#' dim=3, points=coords,
72-
#' transformlist=ch2reg$fwdtransforms,
73-
#' whichtoinvert=c(FALSE,FALSE) )
74-
#' ptrd = 3
75-
#' powersLabels = makePointsImage( coordsw, moving, radius = pard )
76-
#' plot( moving, powersLabels, axis=3, nslices=30 )
62+
#' fixed <- antsImageRead(getANTsRData("ch2"))
63+
#' moving <- antsImageRead(getANTsRData("mni"))
64+
#' mytx <- antsRegistration(
65+
#' fixed = fixed, moving = moving,
66+
#' typeofTransform = c("SyN")
67+
#' )
68+
#' data("powers_areal_mni_itk", package = "ANTsR", envir = environment())
69+
#' coords <- powers_areal_mni_itk[, 1:3]
70+
#' ch2reg <- antsRegistration(fixed, moving, typeofTransform = "SyN")
71+
#' coordsw <- antsApplyTransformsToPoints(
72+
#' dim = 3, points = coords,
73+
#' transformlist = ch2reg$fwdtransforms,
74+
#' whichtoinvert = c(FALSE, FALSE)
75+
#' )
76+
#' ptrd <- 3
77+
#' powersLabels <- makePointsImage(coordsw, moving, radius = pard)
78+
#' plot(moving, powersLabels, axis = 3, nslices = 30)
7779
#' }
7880
#' @keywords datasets
7981
"powers_areal_mni_itk"
8082

8183

8284
#' @title tracts
8385
#' @docType data
84-
#' @description A data frame label numbers and names for
86+
#' @description A data frame label numbers and names for
8587
#' the white matter tracts labels.
8688
#' @format A data frame listing the following variables.
8789
#' \describe{
88-
#' \item{\code{label_num}}{ Numerical label value. }
90+
#' \item{\code{label_num}}{ Numerical label value. }
8991
#' \item{\code{label_name}}{ Shorthand anatomical value. }
9092
#' }
9193
#' @references \url{http://www.ncbi.nlm.nih.gov/pubmed/18407524}
@@ -96,7 +98,7 @@
9698

9799
#' @title AAL Labels
98100
#' @docType data
99-
#' @description A data frame label numbers and names
101+
#' @description A data frame label numbers and names
100102
#' for the neuroanatomical AAL labels.
101103
#' @format A data frame listing the following variables.
102104
#' \describe{
@@ -116,9 +118,9 @@
116118
#' \item{\code{temporal}}{binary value}
117119
#' \item{\code{unknown}}{binary value}
118120
#' }
119-
#' @references
121+
#' @references
120122
#' \url{http://en.wikipedia.org/wiki/Automated_Anatomical_Labeling}
121-
#' @examples
123+
#' @examples
122124
#' data(aal)
123125
#' @keywords datasets
124126
"aal"
@@ -127,15 +129,15 @@
127129
#' @name antsrVersions
128130
#' @title antsrVersions
129131
#' @docType data
130-
#' @description A data frame defining the git tag
131-
#' for the current ANTsR version. One can also see
132-
#' antsrVersions from ANTsRCore to get the git tag for
132+
#' @description A data frame defining the git tag
133+
#' for the current ANTsR version. One can also see
134+
#' antsrVersions from ANTsRCore to get the git tag for
133135
#' those dependencies.
134136
#' @format A data frame listing the following variables.
135137
#' \describe{
136138
#' \item{\code{Dependency}}{ Name of software dependency. }
137-
#' \item{\code{GitTag}}{ The git tag. This can also be used to
138-
#' trace other dependencies, e.g. the ITK version used by the
139+
#' \item{\code{GitTag}}{ The git tag. This can also be used to
140+
#' trace other dependencies, e.g. the ITK version used by the
139141
#' current ANTs version. }
140142
#' }
141143
#' @references \url{https://github.com/stnava/ANTs}

0 commit comments

Comments
 (0)