[Soiltexture-commits] r102 - in pkg/ternaryplot: . R inst/examples man
noreply at r-forge.r-project.org
noreply at r-forge.r-project.org
Fri Mar 28 17:47:09 CET 2014
Author: jmoeys
Date: 2014-03-28 17:47:09 +0100 (Fri, 28 Mar 2014)
New Revision: 102
Removed:
pkg/ternaryplot/R/functionsList.txt
pkg/ternaryplot/man/ternarySystem-class.Rd
Modified:
pkg/ternaryplot/NAMESPACE
pkg/ternaryplot/R/aa02-ternaryplot-classes.R
pkg/ternaryplot/R/aa03-ternaryplot-classes-utility.R
pkg/ternaryplot/R/aa05-ternarydata.R
pkg/ternaryplot/R/ternarygrid.R
pkg/ternaryplot/R/ternaryplot.R
pkg/ternaryplot/REVISION
pkg/ternaryplot/inst/examples/createTernarySystem-example.R
pkg/ternaryplot/inst/examples/ternaryPlot-example.R
pkg/ternaryplot/man/blrClock-methods.Rd
pkg/ternaryplot/man/blrLabels-methods.Rd
pkg/ternaryplot/man/blrNames-methods.Rd
pkg/ternaryplot/man/createTernaryGeometry.Rd
pkg/ternaryplot/man/createTernaryGrid-methods.Rd
pkg/ternaryplot/man/createTernarySystem.Rd
pkg/ternaryplot/man/createTernaryVariables.Rd
pkg/ternaryplot/man/fracSum-methods.Rd
pkg/ternaryplot/man/ternary2SpatialPolygonsDataFrame-methods.Rd
pkg/ternaryplot/man/ternaryData-methods.Rd
pkg/ternaryplot/man/ternaryGeometry-methods.Rd
pkg/ternaryplot/man/ternaryPlot-methods.Rd
pkg/ternaryplot/man/ternaryVariables-methods.Rd
pkg/ternaryplot/man/ternaryWindow-methods.Rd
pkg/ternaryplot/man/tlrAngles-methods.Rd
Log:
Modified: pkg/ternaryplot/NAMESPACE
===================================================================
--- pkg/ternaryplot/NAMESPACE 2014-03-28 15:15:38 UTC (rev 101)
+++ pkg/ternaryplot/NAMESPACE 2014-03-28 16:47:09 UTC (rev 102)
@@ -87,5 +87,6 @@
S3method(ternaryText,ternarySystem)
S3method(ternaryVariables,ternarySystem)
S3method(ternaryWindow,character)
+S3method(ternaryWindow,ternarySystem)
S3method(tlrAngles,ternaryGeometry)
S3method(tlrAngles,ternarySystem)
Modified: pkg/ternaryplot/R/aa02-ternaryplot-classes.R
===================================================================
--- pkg/ternaryplot/R/aa02-ternaryplot-classes.R 2014-03-28 15:15:38 UTC (rev 101)
+++ pkg/ternaryplot/R/aa02-ternaryplot-classes.R 2014-03-28 16:47:09 UTC (rev 102)
@@ -374,7 +374,6 @@
#'
#'
#'@rdname createTernaryGeometry
-#'@aliases ternaryGeometry
#'
#'@export
#'
@@ -435,7 +434,6 @@
#'
#'
#'@rdname createTernaryVariables
-#'@aliases ternaryVariables
#'
#'@export
#'
@@ -521,7 +519,9 @@
#'
#'
#'@rdname createTernarySystem
+#'
#'@aliases ternarySystem
+#'
#'@export
#'
createTernarySystem <- function(
Modified: pkg/ternaryplot/R/aa03-ternaryplot-classes-utility.R
===================================================================
--- pkg/ternaryplot/R/aa03-ternaryplot-classes-utility.R 2014-03-28 15:15:38 UTC (rev 101)
+++ pkg/ternaryplot/R/aa03-ternaryplot-classes-utility.R 2014-03-28 16:47:09 UTC (rev 102)
@@ -65,6 +65,8 @@
#'@rdname blrNames-methods
#'
+#'@usage blrNames( s, ... ) <- value
+#'
#'@export
#'
`blrNames<-` <- function(
@@ -81,6 +83,9 @@
#'
#'@method blrNames<- ternarySystem
#'@S3method blrNames<- ternarySystem
+#'
+#'@usage \method{blrNames}{ternarySystem}(s, ...) <- value
+#'
`blrNames<-.ternarySystem` <- function(
s,
...,
@@ -109,6 +114,9 @@
#'
#'@method blrNames<- ternaryVariables
#'@S3method blrNames<- ternaryVariables
+#'
+#'@usage \method{blrNames}{ternaryVariables}(s, ...) <- value
+#'
`blrNames<-.ternaryVariables` <- function(
s,
...,
@@ -180,6 +188,8 @@
#'@rdname blrLabels-methods
#'
+#'@usage blrLabels( s, ... ) <- value
+#'
#'@export
#'
`blrLabels<-` <- function(
@@ -196,6 +206,9 @@
#'
#'@method blrLabels<- ternarySystem
#'@S3method blrLabels<- ternarySystem
+#'
+#'@usage \method{blrLabels}{ternarySystem}(s, ...) <- value
+#'
`blrLabels<-.ternarySystem` <- function(
s,
...,
@@ -214,6 +227,9 @@
#'
#'@method blrLabels<- ternaryVariables
#'@S3method blrLabels<- ternaryVariables
+#'
+#'@usage \method{blrLabels}{ternaryVariables}(s, ...) <- value
+#'
`blrLabels<-.ternaryVariables` <- function(
s,
...,
@@ -294,11 +310,13 @@
#'@rdname blrClock-methods
#'
+#'@usage blrClock( s, ... ) <- value
+#'
#'@export
#'
`blrClock<-` <- function(
s,
- ...,
+ ...,
value
){
UseMethod( "blrClock<-" )
@@ -310,9 +328,12 @@
#'
#'@method blrClock<- ternarySystem
#'@S3method blrClock<- ternarySystem
+#'
+#'@usage \method{blrClock}{ternarySystem}(s, ...) <- value
+#'
`blrClock<-.ternarySystem` <- function(
s,
- ...,
+ ...,
value
){
s[[ 'ternaryGeometry' ]][[ 'blrClock' ]] <- value
@@ -328,9 +349,12 @@
#'
#'@method blrClock<- ternaryGeometry
#'@S3method blrClock<- ternaryGeometry
+#'
+#'@usage \method{blrClock}{ternaryGeometry}(s, ...) <- value
+#'
`blrClock<-.ternaryGeometry` <- function(
s,
- ...,
+ ...,
value
){
s[[ 'blrClock' ]] <- value
@@ -408,6 +432,8 @@
#'@rdname fracSum-methods
#'
+#'@usage fracSum( s, ... ) <- value
+#'
#'@export
#'
`fracSum<-` <- function(
@@ -424,6 +450,9 @@
#'
#'@method fracSum<- ternarySystem
#'@S3method fracSum<- ternarySystem
+#'
+#'@usage \method{fracSum}{ternarySystem}(s, ...) <- value
+#'
`fracSum<-.ternarySystem` <- function(
s,
...,
@@ -442,6 +471,9 @@
#'
#'@method fracSum<- ternaryGeometry
#'@S3method fracSum<- ternaryGeometry
+#'
+#'@usage \method{fracSum}{ternaryGeometry}(s, ...) <- value
+#'
`fracSum<-.ternaryGeometry` <- function(
s,
...,
@@ -522,6 +554,8 @@
#'@rdname tlrAngles-methods
#'
+#'@usage tlrAngles( s, ... ) <- value
+#'
#'@export
#'
`tlrAngles<-` <- function(
@@ -538,6 +572,9 @@
#'
#'@method tlrAngles<- ternarySystem
#'@S3method tlrAngles<- ternarySystem
+#'
+#'@usage \method{tlrAngles}{ternarySystem}(s, ...) <- value
+#'
`tlrAngles<-.ternarySystem` <- function(
s,
...,
@@ -556,6 +593,9 @@
#'
#'@method tlrAngles<- ternaryGeometry
#'@S3method tlrAngles<- ternaryGeometry
+#'
+#'@usage \method{tlrAngles}{ternaryGeometry}(s, ...) <- value
+#'
`tlrAngles<-.ternaryGeometry` <- function(
s,
...,
@@ -619,6 +659,8 @@
#'@rdname tlrAngles-methods
#'
+#'@usage ternaryGeometry( s, ... ) <- value
+#'
#'@export
#'
`ternaryGeometry<-` <- function(
@@ -635,6 +677,9 @@
#'
#'@method ternaryGeometry<- ternarySystem
#'@S3method ternaryGeometry<- ternarySystem
+#'
+#'@usage \method{ternaryGeometry}{ternarySystem}( s, ... ) <- value
+#'
`ternaryGeometry<-.ternarySystem` <- function(
s,
...,
@@ -698,6 +743,8 @@
#'@rdname ternaryVariables-methods
#'
+#'@usage ternaryVariables( s, ... ) <- value
+#'
#'@export
#'
`ternaryVariables<-` <- function(
@@ -714,6 +761,9 @@
#'
#'@method ternaryVariables<- ternarySystem
#'@S3method ternaryVariables<- ternarySystem
+#'
+#'@usage \method{ternaryVariables}{ternarySystem}( s, ... ) <- value
+#'
`ternaryVariables<-.ternarySystem` <- function(
s,
...,
Modified: pkg/ternaryplot/R/aa05-ternarydata.R
===================================================================
--- pkg/ternaryplot/R/aa05-ternarydata.R 2014-03-28 15:15:38 UTC (rev 101)
+++ pkg/ternaryplot/R/aa05-ternarydata.R 2014-03-28 16:47:09 UTC (rev 102)
@@ -42,12 +42,11 @@
#' containing point ternary data (x-y-x) to be tested.
#'
#'@param .blrNames
-#' Vector of 3 character strings. Column names of the variables
-#' in \code{x} that corresponds to the bottom, left and right
-#' variables in \code{s} (\code{blrNames(s)}). If \code{NULL},
-#' Columns and variable names in \code{x} and \code{s} should
-#' match.
+#' See \code{\link[ternaryplot]{blrNames}}
#'
+#'@param .fracSum
+#' See \code{\link[ternaryplot]{fracSum}}
+#'
#'@param testRange
#' Single logical. Test if the range of fraction is between 0 and
#' the expected sum of fractions (1 or 100).
Deleted: pkg/ternaryplot/R/functionsList.txt
===================================================================
--- pkg/ternaryplot/R/functionsList.txt 2014-03-28 15:15:38 UTC (rev 101)
+++ pkg/ternaryplot/R/functionsList.txt 2014-03-28 16:47:09 UTC (rev 102)
@@ -1,146 +0,0 @@
-
-aa01-ternaryplot-options.R
-
- tpPar
- getTpPar
-
- .tpParList (environment)
- tpParList (environment)
-
-aa02-ternaryplot-classes.R
-
- ternaryCheck ternaryGeometry ternaryVariables ternarySystem
- createTernaryGeometry
- createTernaryVariables
- createTernarySystem
-
-aa03-ternaryplot-classes-utility.R
-
- blrNames ternaryVariables ternarySystem
- blrNames<- ternaryVariables ternarySystem
- blrLabels ternaryVariables ternarySystem
- blrLabels<- ternaryVariables ternarySystem
- blrClock ternaryGeometry ternarySystem
- blrClock<- ternaryGeometry ternarySystem
- fracSum ternaryGeometry ternarySystem
- fracSum<- ternaryGeometry ternarySystem
- tlrAngles ternaryGeometry ternarySystem
- tlrAngles<- ternaryGeometry ternarySystem
- ternaryGeometry ternarySystem
- ternaryGeometry<- ternarySystem
- ternaryVariables ternarySystem
- ternaryVariables<- ternarySystem
-
-aa04-ternarySystems.R
-
- ternarySystemEnv (environment)
- getTernarySystem
- listTernarySystem
-
-onAttach.R
-
- .onAttach
-
-ternaryplot.R
-
- ternaryData ternarySystem character missing (includes tests)
-
- .setTernarySystem
- ternaryWindow ternarySystem character missing
- ternaryBox ternarySystem
- ternaryPoints data.frame matrix >> make function of "ternarySystem character" (+ internal 'data' handling)
- ternarySegments data.frame matrix >> make function of "ternarySystem character" (+ internal 'data' handling)
- ternaryArrows data.frame >> make function of "ternarySystem character" (+ internal 'data' handling)
- .ternaryGridBase ternarySystem
- .ternaryTicks ternarySystem
- ternaryGrid ternarySystem
-
- ternaryPlot data.frame matrix >> make function of "ternarySystem character" (+ internal 'data' handling)
- TO DO: type = "p" points, "l" lines, "b" both, "c" counts,
- "de" density, "di" distance (contour chosen via "...")
- TO DO: facet = {category}, fCol, fPch, zCol, zCex
- TO DO: make axes ticks depend on axTicks()
- TO DO: make arrows and arrows labels distance from the plot a function of margin size using par("plt")
- and *backward* calculating the label position
-
- (1) regression between plt and usr (plt -> usr) for plotting points into margin, in X-axis margin (Y coordinates!)
- (2) convert between axis margin line par( "mgp" )[2] to relative 0-1 coordinates of the margin, using par( "mar" )
- (= number of lines in the margin). Summary mgp -> 0-1 coords -> plt -> XY (usr)
- transfMgpTo0_1() transf0_1ToPlt() transfPltToXY()
- (3) converting from X-Y to ternary coordinates with ternary2xy()
- that gives the Y-distance between the triangle frame and the axis labels
- (4) Using that distance to position the other two axis arrows and labels
-
- ternaryLims data.frame matrix >> make function of "ternarySystem character" (+ internal 'data' handling)
- deg2rad
- ternary2xy data.frame matrix >> make function of "ternarySystem character" (+ internal 'data' handling)
- ternaryClockSwitch data.frame matrix >> make function of "ternarySystem character" (+ internal 'data' handling)
- ternaryText data.frame matrix >> make function of "ternarySystem character" (+ internal 'data' handling)
- .ternaryAxisArrowsBase ternarySystem
- .ternaryAxisArrows ternarySystem
-
- TO DO: ternaryLines ternarySystem
-
- TO DO: ternaryPolygon ternarySystem
- TO DO: ternaryClasses ternarySystem >> draw ternary classification systems
- TO DO: ternaryClassify ternarySystem >> Same as ternaryOver
-
- TO DO: ternaryDensity ternarySystem
- TO DO: ternaryBin ternarySystem
- TO DO: ternaryDistance mahalanobis
- TO DO: ternaryContour ternaryDensity ternaryBin
-
- TO DO: ternaryNormalise ternarySystem
-
- TO DO: as.data.frame ternarySystem >> what = "vertices" or "classes"
-
- TO DO: ternaryTheme( "default" ) Switch between themes
- TO DO: more graphical parameters from par() can be overwritten with tpPar()
-
- TO DO: ternary2SpatialPointsDataFrame ternarySystem+data.frame or ternaryData or ternarySystem (includes extra columns)
- TO DO: ternary2SpatialPolygonsDataFrame ternarySystem or ternaryPolygons (classes)
-
- TO DO: ternaryOver >> ternary version of sp::over
- TO DO: ternaryAggregate >> ternary version of sp::aggregate
-
- TO DO: use ternaryGrid (ternaryPolygons) + ternaryAggregate to calculate summary statistics
-
-
-Examples:
-
- Ternary Diagrams of Shepard and Pejrup:
- http://rgm3.lab.nig.ac.jp/RGM/R_rdfile?f=rysgran/man/rysgran.ternary.Rd&d=R_CC
- http://www.mgs.md.gov/coastal_geology/shepards.html
-
- QAPF diagram:
- http://en.wikipedia.org/wiki/QAPF_diagram
-
- http://en.wikipedia.org/wiki/De_Finetti_diagram
-
-Graphical parameters:
-
- See plotParameters.xls
-
- Notes:
- Number segments in arrows yes tpPar("arrow.seg")
- Margins no tpPar("mar")
-
- type =
- "n" nothing
- "p" points (ternaryPoints) or text if !is.null(labels) (ternaryText)
- "l" lines (ternaryLines)
- "b" both points and lines
- "d" density (ternaryGrid + ternaryDensity)
- "c" counts (ternaryGrid + ternaryCounts)
-
- facet Factor variable for plot facets (sub-plots)
-
- extra A list of parameters passed to ternaryPoints or ternaryLines
- fPch Factor variable for point symbols
- fCol Factor variable for point or line colors
- fLty Factor variable for line type
- cCol Continuous variable for point or line colors use cut( x, breaks = 5 )
- cCex Continuous variable for point expansion use cut( x, breaks = 5 )
- position Legend position(s) (if several)
-
-
\ No newline at end of file
Modified: pkg/ternaryplot/R/ternarygrid.R
===================================================================
--- pkg/ternaryplot/R/ternarygrid.R 2014-03-28 15:15:38 UTC (rev 101)
+++ pkg/ternaryplot/R/ternarygrid.R 2014-03-28 16:47:09 UTC (rev 102)
@@ -19,6 +19,9 @@
#' Either a single character string, or a \code{ternarySystem}
#' object, as obtained from \code{\link[ternaryplot]{getTernarySystem}}
#'
+#'@param n
+#' Single integer value. Number of intervals
+#'
#'@param \dots
#' Additional parameters passed to specific methods.
#'
@@ -140,12 +143,14 @@
+# ternary2SpatialPolygonsDataFrame ==============================
+
#'Converts ternary*-class objects to SpatialPolygonsDataFrame
#'
#'Converts ternary*-class objects to \code{\link[sp]{SpatialPolygonsDataFrame}}
#'
#'
-#'@param s
+#'@param x
#' A ternary*-class object.
#'
#'@param \dots
@@ -173,6 +178,9 @@
#'
#'@method ternary2SpatialPolygonsDataFrame ternaryPolygons
#'@S3method ternary2SpatialPolygonsDataFrame ternaryPolygons
+#'
+#'@usage \method{ternary2SpatialPolygonsDataFrame}{ternaryPolygons}( x, ... )
+#'
ternary2SpatialPolygonsDataFrame.ternaryPolygons <- function(
x,
...
Modified: pkg/ternaryplot/R/ternaryplot.R
===================================================================
--- pkg/ternaryplot/R/ternaryplot.R 2014-03-28 15:15:38 UTC (rev 101)
+++ pkg/ternaryplot/R/ternaryplot.R 2014-03-28 16:47:09 UTC (rev 102)
@@ -79,8 +79,8 @@
#'@rdname ternaryWindow-methods
#'
-#'@method ternaryWindow character
-#'@S3method ternaryWindow character
+#'@method ternaryWindow ternarySystem
+#'@S3method ternaryWindow ternarySystem
ternaryWindow.ternarySystem <- function(
s,
x,
Modified: pkg/ternaryplot/REVISION
===================================================================
--- pkg/ternaryplot/REVISION 2014-03-28 15:15:38 UTC (rev 101)
+++ pkg/ternaryplot/REVISION 2014-03-28 16:47:09 UTC (rev 102)
@@ -1 +1 @@
-95:100M
+95:101M
Modified: pkg/ternaryplot/inst/examples/createTernarySystem-example.R
===================================================================
--- pkg/ternaryplot/inst/examples/createTernarySystem-example.R 2014-03-28 15:15:38 UTC (rev 101)
+++ pkg/ternaryplot/inst/examples/createTernarySystem-example.R 2014-03-28 16:47:09 UTC (rev 102)
@@ -1,3 +1,4 @@
+
library( "ternaryplot" )
@@ -11,8 +12,7 @@
"blrNames" = c( "CLAY", "SILT", "SAND" ),
"blrLabels" = c( "Clay [%]", "Silt [%]", "Sand [%]" )
),
- "ternaryGeometry" = createTernaryGeometry(
- "ternaryGeometry",
+ "ternaryGeometry" = createTernaryGeometry( ##
"fracSum" = 100,
"tlrAngles" = c( 45, 45, 90 ) # top, left, right angles
),
Modified: pkg/ternaryplot/inst/examples/ternaryPlot-example.R
===================================================================
--- pkg/ternaryplot/inst/examples/ternaryPlot-example.R 2014-03-28 15:15:38 UTC (rev 101)
+++ pkg/ternaryplot/inst/examples/ternaryPlot-example.R 2014-03-28 16:47:09 UTC (rev 102)
@@ -22,7 +22,7 @@
# ========================================================
# Set new orientation
-blrClock( s ) <- rep( F, 3 )
+blrClock( s ) <- rep( FALSE, 3 )
# Plot
ternaryPlot(s)
@@ -32,7 +32,7 @@
# ========================================
# Set new orientation and angles
-blrClock( s ) <- c( F, T, NA )
+blrClock( s ) <- c( FALSE, TRUE, NA )
tlrAngles( s ) <- c( 45, 90, 45 )
# Plot
@@ -42,7 +42,7 @@
# Same, other direction
# =====================
-blrClock( s ) <- c( T, NA, F )
+blrClock( s ) <- c( TRUE, NA, FALSE )
tlrAngles( s ) <- c(45,45,90)
ternaryPlot(s)
Modified: pkg/ternaryplot/man/blrClock-methods.Rd
===================================================================
--- pkg/ternaryplot/man/blrClock-methods.Rd 2014-03-28 15:15:38 UTC (rev 101)
+++ pkg/ternaryplot/man/blrClock-methods.Rd 2014-03-28 16:47:09 UTC (rev 102)
@@ -14,12 +14,11 @@
\method{blrClock}{ternaryGeometry} (s, ...)
- blrClock(s, ..., value) <- value
+ blrClock( s, ... ) <- value
- \method{blrClock}{ternarySystem} (s, ..., value) <- value
+ \method{blrClock}{ternarySystem}(s, ...) <- value
- \method{blrClock}{ternaryGeometry} (s, ..., value) <-
- value
+ \method{blrClock}{ternaryGeometry}(s, ...) <- value
}
\arguments{
\item{s}{A \code{ternarySystem} object, as created with
Modified: pkg/ternaryplot/man/blrLabels-methods.Rd
===================================================================
--- pkg/ternaryplot/man/blrLabels-methods.Rd 2014-03-28 15:15:38 UTC (rev 101)
+++ pkg/ternaryplot/man/blrLabels-methods.Rd 2014-03-28 16:47:09 UTC (rev 102)
@@ -14,13 +14,11 @@
\method{blrLabels}{ternaryVariables} (s, ...)
- blrLabels(s, ..., value) <- value
+ blrLabels( s, ... ) <- value
- \method{blrLabels}{ternarySystem} (s, ..., value) <-
- value
+ \method{blrLabels}{ternarySystem}(s, ...) <- value
- \method{blrLabels}{ternaryVariables} (s, ..., value) <-
- value
+ \method{blrLabels}{ternaryVariables}(s, ...) <- value
}
\arguments{
\item{s}{A \code{ternarySystem} object, as created with
Modified: pkg/ternaryplot/man/blrNames-methods.Rd
===================================================================
--- pkg/ternaryplot/man/blrNames-methods.Rd 2014-03-28 15:15:38 UTC (rev 101)
+++ pkg/ternaryplot/man/blrNames-methods.Rd 2014-03-28 16:47:09 UTC (rev 102)
@@ -14,12 +14,11 @@
\method{blrNames}{ternaryVariables} (s, ...)
- blrNames(s, ..., value) <- value
+ blrNames( s, ... ) <- value
- \method{blrNames}{ternarySystem} (s, ..., value) <- value
+ \method{blrNames}{ternarySystem}(s, ...) <- value
- \method{blrNames}{ternaryVariables} (s, ..., value) <-
- value
+ \method{blrNames}{ternaryVariables}(s, ...) <- value
}
\arguments{
\item{s}{A \code{ternarySystem} object, as created with
Modified: pkg/ternaryplot/man/createTernaryGeometry.Rd
===================================================================
--- pkg/ternaryplot/man/createTernaryGeometry.Rd 2014-03-28 15:15:38 UTC (rev 101)
+++ pkg/ternaryplot/man/createTernaryGeometry.Rd 2014-03-28 16:47:09 UTC (rev 102)
@@ -1,6 +1,5 @@
\name{createTernaryGeometry}
\alias{createTernaryGeometry}
-\alias{ternaryGeometry}
\title{Creates a ternaryGeometry object: ternary plot geometry definition.}
\usage{
createTernaryGeometry(tlrAngles = c(60, 60, 60),
Modified: pkg/ternaryplot/man/createTernaryGrid-methods.Rd
===================================================================
--- pkg/ternaryplot/man/createTernaryGrid-methods.Rd 2014-03-28 15:15:38 UTC (rev 101)
+++ pkg/ternaryplot/man/createTernaryGrid-methods.Rd 2014-03-28 16:47:09 UTC (rev 102)
@@ -16,6 +16,8 @@
\code{ternarySystem} object, as obtained from
\code{\link[ternaryplot]{getTernarySystem}}}
+ \item{n}{Single integer value. Number of intervals}
+
\item{\dots}{Additional parameters passed to specific
methods.}
}
Modified: pkg/ternaryplot/man/createTernarySystem.Rd
===================================================================
--- pkg/ternaryplot/man/createTernarySystem.Rd 2014-03-28 15:15:38 UTC (rev 101)
+++ pkg/ternaryplot/man/createTernarySystem.Rd 2014-03-28 16:47:09 UTC (rev 102)
@@ -61,6 +61,7 @@
(in \code{classes}) with different \code{vertices}.
}
\examples{
+
library( "ternaryplot" )
@@ -74,8 +75,7 @@
"blrNames" = c( "CLAY", "SILT", "SAND" ),
"blrLabels" = c( "Clay [\%]", "Silt [\%]", "Sand [\%]" )
),
- "ternaryGeometry" = createTernaryGeometry(
- "ternaryGeometry",
+ "ternaryGeometry" = createTernaryGeometry( ##
"fracSum" = 100,
"tlrAngles" = c( 45, 45, 90 ) # top, left, right angles
),
Modified: pkg/ternaryplot/man/createTernaryVariables.Rd
===================================================================
--- pkg/ternaryplot/man/createTernaryVariables.Rd 2014-03-28 15:15:38 UTC (rev 101)
+++ pkg/ternaryplot/man/createTernaryVariables.Rd 2014-03-28 16:47:09 UTC (rev 102)
@@ -1,6 +1,5 @@
\name{createTernaryVariables}
\alias{createTernaryVariables}
-\alias{ternaryVariables}
\title{Creates a ternaryVariables object: ternary plot variables definitions.}
\usage{
createTernaryVariables(blrNames = paste0("F", 1:3),
Modified: pkg/ternaryplot/man/fracSum-methods.Rd
===================================================================
--- pkg/ternaryplot/man/fracSum-methods.Rd 2014-03-28 15:15:38 UTC (rev 101)
+++ pkg/ternaryplot/man/fracSum-methods.Rd 2014-03-28 16:47:09 UTC (rev 102)
@@ -14,12 +14,11 @@
\method{fracSum}{ternaryGeometry} (s, ...)
- fracSum(s, ..., value) <- value
+ fracSum( s, ... ) <- value
- \method{fracSum}{ternarySystem} (s, ..., value) <- value
+ \method{fracSum}{ternarySystem}(s, ...) <- value
- \method{fracSum}{ternaryGeometry} (s, ..., value) <-
- value
+ \method{fracSum}{ternaryGeometry}(s, ...) <- value
}
\arguments{
\item{s}{A \code{ternarySystem} object, as created with
Modified: pkg/ternaryplot/man/ternary2SpatialPolygonsDataFrame-methods.Rd
===================================================================
--- pkg/ternaryplot/man/ternary2SpatialPolygonsDataFrame-methods.Rd 2014-03-28 15:15:38 UTC (rev 101)
+++ pkg/ternaryplot/man/ternary2SpatialPolygonsDataFrame-methods.Rd 2014-03-28 16:47:09 UTC (rev 102)
@@ -5,11 +5,11 @@
\usage{
ternary2SpatialPolygonsDataFrame(x, ...)
- \method{ternary2SpatialPolygonsDataFrame}{ternaryPolygons}
- (x, ...)
+ \method{ternary2SpatialPolygonsDataFrame}{ternaryPolygons}(
+ x, ... )
}
\arguments{
- \item{s}{A ternary*-class object.}
+ \item{x}{A ternary*-class object.}
\item{\dots}{Additional parameters passed to specific
methods.}
Modified: pkg/ternaryplot/man/ternaryData-methods.Rd
===================================================================
--- pkg/ternaryplot/man/ternaryData-methods.Rd 2014-03-28 15:15:38 UTC (rev 101)
+++ pkg/ternaryplot/man/ternaryData-methods.Rd 2014-03-28 16:47:09 UTC (rev 102)
@@ -21,12 +21,10 @@
\code{\link[base]{matrix}} containing point ternary data
(x-y-x) to be tested.}
- \item{.blrNames}{Vector of 3 character strings. Column
- names of the variables in \code{x} that corresponds to
- the bottom, left and right variables in \code{s}
- (\code{blrNames(s)}). If \code{NULL}, Columns and
- variable names in \code{x} and \code{s} should match.}
+ \item{.blrNames}{See \code{\link[ternaryplot]{blrNames}}}
+ \item{.fracSum}{See \code{\link[ternaryplot]{fracSum}}}
+
\item{testRange}{Single logical. Test if the range of
fraction is between 0 and the expected sum of fractions
(1 or 100).}
Modified: pkg/ternaryplot/man/ternaryGeometry-methods.Rd
===================================================================
--- pkg/ternaryplot/man/ternaryGeometry-methods.Rd 2014-03-28 15:15:38 UTC (rev 101)
+++ pkg/ternaryplot/man/ternaryGeometry-methods.Rd 2014-03-28 16:47:09 UTC (rev 102)
@@ -8,8 +8,8 @@
\method{ternaryGeometry}{ternarySystem} (s, ...)
- \method{ternaryGeometry}{ternarySystem} (s, ..., value)
- <- value
+ \method{ternaryGeometry}{ternarySystem}( s, ... ) <-
+ value
}
\arguments{
\item{s}{A \code{ternarySystem} object, as created with
Modified: pkg/ternaryplot/man/ternaryPlot-methods.Rd
===================================================================
--- pkg/ternaryplot/man/ternaryPlot-methods.Rd 2014-03-28 15:15:38 UTC (rev 101)
+++ pkg/ternaryplot/man/ternaryPlot-methods.Rd 2014-03-28 16:47:09 UTC (rev 102)
@@ -62,7 +62,7 @@
# ========================================================
# Set new orientation
-blrClock( s ) <- rep( F, 3 )
+blrClock( s ) <- rep( FALSE, 3 )
# Plot
ternaryPlot(s)
@@ -72,7 +72,7 @@
# ========================================
# Set new orientation and angles
-blrClock( s ) <- c( F, T, NA )
+blrClock( s ) <- c( FALSE, TRUE, NA )
tlrAngles( s ) <- c( 45, 90, 45 )
# Plot
@@ -82,7 +82,7 @@
# Same, other direction
# =====================
-blrClock( s ) <- c( T, NA, F )
+blrClock( s ) <- c( TRUE, NA, FALSE )
tlrAngles( s ) <- c(45,45,90)
ternaryPlot(s)
Deleted: pkg/ternaryplot/man/ternarySystem-class.Rd
===================================================================
--- pkg/ternaryplot/man/ternarySystem-class.Rd 2014-03-28 15:15:38 UTC (rev 101)
+++ pkg/ternaryplot/man/ternarySystem-class.Rd 2014-03-28 16:47:09 UTC (rev 102)
@@ -1,86 +0,0 @@
-\name{ternarySystem-class}
-\alias{ternarySystem-class}
-\title{Creates a ternarySystem object: ternary plot system definition.}
-\usage{
- createTernarySystem(ternaryGeometry = NULL,
- ternaryVariables = NULL, main = character(0),
- vertices = NULL, classes = NULL, scale = NULL, ...)
-}
-\arguments{
- \item{ternaryGeometry}{A ternary geometry (as defined by
- \code{\link[ternaryplot]{createTernaryGeometry}}). If
- \code{NULL}, use the default output of
- \code{\link[ternaryplot]{createTernaryGeometry}}.}
-
- \item{ternaryVariables}{A set of ternary variables (as
- defined by
- \code{\link[ternaryplot]{createTernaryVariables}}. If
- \code{NULL}, use the default output of
- \code{\link[ternaryplot]{createTernaryVariables}}.}
-
- \item{main}{Single character string. Title of the
- triangle plot.}
-
- \item{vertices}{See \code{\link[ternaryplot]{tpPar}}. If
- non-null, \code{\link[base]{data.frame}} with 4 columns:
- \code{id}, and 3 other columns corresponding to
- \code{blrNames} in \code{ternaryVariables}. If
- \code{NULL}, default values will be used
- \code{getTpPar("vertices")}, and the columns names
- changed to those of \code{ternaryVariables}.}
-
- \item{classes}{See \code{\link[ternaryplot]{tpPar}}.}
-
- \item{scale}{See \code{\link[ternaryplot]{tpPar}}. If
- non-null, \code{\link[base]{data.frame}} with 3 columns,
- corresponding to \code{blrNames} in
- \code{ternaryVariables}. If \code{NULL}, default values
- will be used \code{getTpPar("scale")}, and the columns
- names changed to those of \code{ternaryVariables}. NOT
- USED YET.}
-
- \item{\dots}{Additional parameters passed to
- \code{\link[ternaryplot]{ternaryCheck}}}
-}
-\description{
- Creates a ternarySystem object: ternary plot system
- definition.
-}
-\details{
- Ternary systems are a combination of (a) a ternary
- geometry (as defined by
- \code{\link[ternaryplot]{createTernaryGeometry}}), (b) a
- set of ternary variables (as defined by
- \code{\link[ternaryplot]{createTernaryVariables}} and an
- optional classification system, that is polygons drawn on
- top of ternary plots, that define different zones in the
- fractions.
-
- The classification is defined by a collection of polygons
- (in \code{classes}) with different \code{vertices}.
-}
-\examples{
-library( "ternaryplot" )
-
-
-## Default variables
-tsy <- createTernarySystem()
-tsy
-
-## Custom variables
-tsy2 <- createTernarySystem(
- "ternaryVariables" = createTernaryVariables(
- "blrNames" = c( "CLAY", "SILT", "SAND" ),
- "blrLabels" = c( "Clay [\%]", "Silt [\%]", "Sand [\%]" )
- ),
- "ternaryGeometry" = createTernaryGeometry(
- "ternaryGeometry",
- "fracSum" = 100,
- "tlrAngles" = c( 45, 45, 90 ) # top, left, right angles
- ),
- "main" = "My ternary plot" )
-
-tsy2
-
-}
-
Modified: pkg/ternaryplot/man/ternaryVariables-methods.Rd
===================================================================
--- pkg/ternaryplot/man/ternaryVariables-methods.Rd 2014-03-28 15:15:38 UTC (rev 101)
+++ pkg/ternaryplot/man/ternaryVariables-methods.Rd 2014-03-28 16:47:09 UTC (rev 102)
@@ -9,10 +9,10 @@
\method{ternaryVariables}{ternarySystem} (s, ...)
- ternaryVariables(s, ..., value) <- value
+ ternaryVariables( s, ... ) <- value
- \method{ternaryVariables}{ternarySystem} (s, ..., value)
- <- value
+ \method{ternaryVariables}{ternarySystem}( s, ... ) <-
+ value
}
\arguments{
\item{s}{A \code{ternarySystem} object, as created with
Modified: pkg/ternaryplot/man/ternaryWindow-methods.Rd
===================================================================
--- pkg/ternaryplot/man/ternaryWindow-methods.Rd 2014-03-28 15:15:38 UTC (rev 101)
+++ pkg/ternaryplot/man/ternaryWindow-methods.Rd 2014-03-28 16:47:09 UTC (rev 102)
@@ -9,8 +9,8 @@
\method{ternaryWindow}{character} (s, x, scale = FALSE,
...)
- \method{ternaryWindow}{character} (s, x, scale = FALSE,
- ...)
+ \method{ternaryWindow}{ternarySystem} (s, x,
+ scale = FALSE, ...)
}
\arguments{
\item{s}{A \code{ternarySystem} object, as created with
Modified: pkg/ternaryplot/man/tlrAngles-methods.Rd
===================================================================
--- pkg/ternaryplot/man/tlrAngles-methods.Rd 2014-03-28 15:15:38 UTC (rev 101)
+++ pkg/ternaryplot/man/tlrAngles-methods.Rd 2014-03-28 16:47:09 UTC (rev 102)
@@ -15,15 +15,13 @@
\method{tlrAngles}{ternaryGeometry} (s, ...)
- tlrAngles(s, ..., value) <- value
+ tlrAngles( s, ... ) <- value
- \method{tlrAngles}{ternarySystem} (s, ..., value) <-
- value
+ \method{tlrAngles}{ternarySystem}(s, ...) <- value
- \method{tlrAngles}{ternaryGeometry} (s, ..., value) <-
- value
+ \method{tlrAngles}{ternaryGeometry}(s, ...) <- value
- ternaryGeometry(s, ..., value) <- value
+ ternaryGeometry( s, ... ) <- value
}
\arguments{
\item{s}{A \code{ternarySystem} object, as created with
More information about the Soiltexture-commits
mailing list