[spcopula-commits] r91 - / pkg pkg/R pkg/man
noreply at r-forge.r-project.org
noreply at r-forge.r-project.org
Fri Apr 5 12:53:11 CEST 2013
Author: ben_graeler
Date: 2013-04-05 12:53:10 +0200 (Fri, 05 Apr 2013)
New Revision: 91
Added:
pkg/man/condSpVine.Rd
pkg/man/spCopPredict.Rd
Modified:
pkg/DESCRIPTION
pkg/R/Classes.R
pkg/R/spatialPreparation.R
pkg/man/BB1Copula-class.Rd
pkg/man/BB1Copula.Rd
pkg/man/BB6Copula-class.Rd
pkg/man/BB6Copula.Rd
pkg/man/BB7Copula-class.Rd
pkg/man/BB7Copula.Rd
pkg/man/BB8Copula-class.Rd
pkg/man/BB8Copula.Rd
pkg/man/asCopula.Rd
pkg/man/calcBins.Rd
pkg/man/composeSpCopula.Rd
pkg/man/copulaFromFamilyIndex.Rd
pkg/man/criticalLevel.Rd
pkg/man/criticalPair.Rd
pkg/man/criticalTriple.Rd
pkg/man/dduCopula.Rd
pkg/man/dependencePlot.Rd
pkg/man/empiricalCopula-class.Rd
pkg/man/empiricalCopula.Rd
pkg/man/fitCorFun.Rd
pkg/man/fitSpCopula.Rd
pkg/man/genEmpCop.Rd
pkg/man/genEmpKenFun.Rd
pkg/man/getKendallDistr.Rd
pkg/man/getNeighbours.Rd
pkg/man/joeBiCopula-class.Rd
pkg/man/kendallDistribution.Rd
pkg/man/kendallRP.Rd
pkg/man/loglikByCopulasLags.Rd
pkg/man/neighbourhood-class.Rd
pkg/man/neighbourhood.Rd
pkg/man/qCopula_u.Rd
pkg/man/rankTransform.Rd
pkg/man/simulatedTriples.Rd
pkg/man/spCopula-class.Rd
pkg/man/spCopula.Rd
pkg/man/spVineCopula-class.Rd
pkg/man/spcopula-package.Rd
pkg/man/surClaytonCopula-class.Rd
pkg/man/surClaytonCopula.Rd
pkg/man/surGumbelCopula-class.Rd
pkg/man/surGumbelCopula.Rd
pkg/man/unitScatter.Rd
pkg/man/vineCopula-class.Rd
pkg/man/vineCopula.Rd
spcopula_0.1-1.tar.gz
spcopula_0.1-1.zip
Log:
- spell check
- documentation spCopPredict.Rd, condSpVine.Rd
Modified: pkg/DESCRIPTION
===================================================================
--- pkg/DESCRIPTION 2013-04-04 17:50:25 UTC (rev 90)
+++ pkg/DESCRIPTION 2013-04-05 10:53:10 UTC (rev 91)
@@ -2,7 +2,7 @@
Type: Package
Title: copula driven spatial analysis
Version: 0.1-1
-Date: 2013-04-04
+Date: 2013-04-05
Author: Benedikt Graeler
Maintainer: Benedikt Graeler <ben.graeler at uni-muenster.de>
Description: This package provides a framework to analyse via copulas spatial and spatio-temporal data provided in the format of the spacetime package. Additionally, support for calculating different multivariate return periods is implemented.
Modified: pkg/R/Classes.R
===================================================================
--- pkg/R/Classes.R 2013-04-04 17:50:25 UTC (rev 90)
+++ pkg/R/Classes.R 2013-04-05 10:53:10 UTC (rev 91)
@@ -190,7 +190,7 @@
# index: a matrix linking the data entries with the coordinates of the locations
validNeighbourhood <- function(object) {
sizeN <- ncol(object at distances)+1
- nVars <- length(object at varNames)
+ nVars <- length(object at var)
if (nrow(object at data) != nrow(object at distances)) return("Data and distances have unequal number of rows.")
if (ncol(object at data) %% (sizeN-object at prediction) != 0) return("Data and distances have non matching number of columns.")
if (nrow(object at data) != nrow(object at index)) return("Data and index have unequal number of rows.")
@@ -204,7 +204,7 @@
distances="matrix",
index="matrix",
locations="Spatial",
- varNames="character",
+ var="character",
prediction="logical"),
validity = validNeighbourhood, contains = list("Spatial"))
Modified: pkg/R/spatialPreparation.R
===================================================================
--- pkg/R/spatialPreparation.R 2013-04-04 17:50:25 UTC (rev 90)
+++ pkg/R/spatialPreparation.R 2013-04-05 10:53:10 UTC (rev 91)
@@ -11,13 +11,13 @@
# sp="SpatialPoints" SpatialPoints object providing the coordinates
# index="matrix" linking the obs. in data to the coordinates
-neighbourhood <- function(data, distances, sp, index, prediction, varNames){
+neighbourhood <- function(data, distances, sp, index, prediction, var){
sizeN <- ncol(distances)+1
data <- as.data.frame(data)
- colnames(data) <- paste(paste("N", rep((0+prediction):(sizeN-1), each=length(varNames)), sep=""),
- rep(varNames,(sizeN-prediction)),sep=".")
+ colnames(data) <- paste(paste("N", rep((0+prediction):(sizeN-1), each=length(var)), sep=""),
+ rep(var,(sizeN-prediction)),sep=".")
new("neighbourhood", data=data, distances=distances, locations=sp,
- bbox=sp at bbox, proj4string=sp at proj4string, index=index, varNames=varNames,
+ bbox=sp at bbox, proj4string=sp at proj4string, index=index, var=var,
prediction=prediction)
}
@@ -25,20 +25,22 @@
showNeighbourhood <- function(object){
cat("A set of neighbourhoods consisting of", ncol(object at distances)+1, "locations each \n")
cat("with",nrow(object at data),"rows of observations for:\n")
- cat(object at varNames,"\n")
+ cat(object at var,"\n")
}
setMethod(show,signature("neighbourhood"),showNeighbourhood)
## names (from sp)
-setMethod(names, signature("neighbourhood"), namesNeighbourhood <- function(x) x at varNames)
+setMethod(names, signature("neighbourhood"), namesNeighbourhood <- function(x) x at var)
## spplot ##
-
spplotNeighbourhood <- function(obj, zcol=names(obj), ..., column=0) {
- pattern <- paste(paste("N",column,".",sep=""),zcol,sep="")
- spdf <- SpatialPointsDataFrame(coords=obj at coords, data=obj at data[,pattern,drop=FALSE], proj4string=obj at proj4string, bbox=obj at bbox)
+ stopifnot(all(column<ncol(obj at data)))
+ pattern <- paste(paste("N", column, ".", sep=""), zcol, sep="")
+ spdf <- SpatialPointsDataFrame(coords=obj at locations,
+ data=obj at data[,pattern,drop=FALSE],
+ proj4string=obj at proj4string, bbox=obj at bbox)
spplot(spdf, ...)
}
@@ -54,7 +56,7 @@
# is one less than for the copula estimation (default of 5)
# min.dist the minimum distance between neighbours, must be positive
-getNeighbours <- function(spData, locations, var=names(spData), size=5,
+getNeighbours <- function(spData, locations, var=names(spData)[1], size=5,
prediction=FALSE, min.dist=0.01) {
stopifnot((!prediction && missing(locations)) || (prediction && !missing(locations)))
@@ -70,7 +72,7 @@
if(any(is.na(match(var,names(spData)))))
stop("At least one of the variables is unkown or is not part of the data.")
- size <- min(size,length(spData))
+ size <- min(size,length(spData)+prediction)
allDists <- NULL
allLocs <- NULL
Modified: pkg/man/BB1Copula-class.Rd
===================================================================
--- pkg/man/BB1Copula-class.Rd 2013-04-04 17:50:25 UTC (rev 90)
+++ pkg/man/BB1Copula-class.Rd 2013-04-05 10:53:10 UTC (rev 91)
@@ -30,7 +30,7 @@
\title{Classes \code{"BB1Copula"}, \code{"surBB1Copula"}, \code{"r90BB1Copula"} and \code{"r270BB1Copula"}}
\description{
-Wrapper classes representing the BB1, survial BB1, 90 degree and 270 degree rotated BB1 copula families (Joe 1997) from \code{\link{VineCopula-package}}.
+Wrapper classes representing the BB1, survival BB1, 90 degree and 270 degree rotated BB1 copula families (Joe 1997) from \code{\link{VineCopula-package}}.
}
\section{Objects from the Classes}{
Objects can be created by calls of the form \code{new("BB1Copula", ...)}, \code{new("surBB1Copula", ...)}, \code{new("r90BB1Copula", ...)} and \code{new("r270BB1Copula", ...)} or by the functions \code{\link{BB1Copula}}, \code{\link{surBB1Copula}}, \code{\link{r90BB1Copula}} and \code{\link{r270BB1Copula}}.
Modified: pkg/man/BB1Copula.Rd
===================================================================
--- pkg/man/BB1Copula.Rd 2013-04-04 17:50:25 UTC (rev 90)
+++ pkg/man/BB1Copula.Rd 2013-04-05 10:53:10 UTC (rev 91)
@@ -5,7 +5,7 @@
\alias{r270BB1Copula}
\title{
-Constructor of the BB1 family and its derivates
+Constructor of the BB1 family and its derivatives
}
\description{
Constructs an object of the \code{\linkS4class{BB1Copula}} (survival \code{sur}, 90 degree rotated \code{r90} and 270 degree rotated \code{r270}) family for a given parameter.
Modified: pkg/man/BB6Copula-class.Rd
===================================================================
--- pkg/man/BB6Copula-class.Rd 2013-04-04 17:50:25 UTC (rev 90)
+++ pkg/man/BB6Copula-class.Rd 2013-04-05 10:53:10 UTC (rev 91)
@@ -30,7 +30,7 @@
\title{Classes \code{"BB6Copula"}, \code{"surBB6Copula"}, \code{"r90BB6Copula"} and \code{"r270BB6Copula"}}
\description{
-Wrapper classes representing the BB6, survial BB6, 90 degree and 270 degree rotated BB6 copula families (Joe 1997) from the \code{\link{VineCopula-package}}.
+Wrapper classes representing the BB6, survival BB6, 90 degree and 270 degree rotated BB6 copula families (Joe 1997) from the \code{\link{VineCopula-package}}.
}
\section{Objects from the Classes}{
Objects can be created by calls of the form \code{new("BB6Copula", ...)}, \code{new("surBB6Copula", ...)}, \code{new("r90BB6Copula", ...)} and \code{new("r270BB6Copula", ...)} or by the functions \code{\link{BB6Copula}}, \code{\link{surBB6Copula}}, \code{\link{r90BB6Copula}} and \code{\link{r270BB6Copula}}.
Modified: pkg/man/BB6Copula.Rd
===================================================================
--- pkg/man/BB6Copula.Rd 2013-04-04 17:50:25 UTC (rev 90)
+++ pkg/man/BB6Copula.Rd 2013-04-05 10:53:10 UTC (rev 91)
@@ -5,7 +5,7 @@
\alias{r270BB6Copula}
\title{
-Constructor of the BB6 family and its derivates
+Constructor of the BB6 family and its derivatives
}
\description{
Constructs an object of the \code{\linkS4class{BB6Copula}} (survival \code{sur}, 90 degree rotated \code{r90} and 270 degree rotated \code{r270}) family for a given parameter.
Modified: pkg/man/BB7Copula-class.Rd
===================================================================
--- pkg/man/BB7Copula-class.Rd 2013-04-04 17:50:25 UTC (rev 90)
+++ pkg/man/BB7Copula-class.Rd 2013-04-05 10:53:10 UTC (rev 91)
@@ -30,7 +30,7 @@
\title{Classes \code{"BB7Copula"}, \code{"surBB7Copula"}, \code{"r90BB7Copula"} and \code{"r270BB7Copula"}}
\description{
-Wrapper classes representing the BB7, survial BB7, 90 degree and 270 degree rotated BB7 copula families (Joe 1997) from the \code{\link{VineCopula-package}} package.
+Wrapper classes representing the BB7, survival BB7, 90 degree and 270 degree rotated BB7 copula families (Joe 1997) from the \code{\link{VineCopula-package}} package.
}
\section{Objects from the Classes}{
Objects can be created by calls of the form \code{new("BB7Copula", ...)}, \code{new("surBB7Copula", ...)}, \code{new("r90BB7Copula", ...)} and \code{new("r270BB7Copula", ...)} or by the functions \code{\link{BB7Copula}}, \code{\link{surBB7Copula}}, \code{\link{r90BB7Copula}} and \code{\link{r270BB7Copula}}.
Modified: pkg/man/BB7Copula.Rd
===================================================================
--- pkg/man/BB7Copula.Rd 2013-04-04 17:50:25 UTC (rev 90)
+++ pkg/man/BB7Copula.Rd 2013-04-05 10:53:10 UTC (rev 91)
@@ -5,7 +5,7 @@
\alias{r270BB7Copula}
\title{
-Constructor of the BB7 family and its derivates
+Constructor of the BB7 family and its derivatives
}
\description{
Constructs an object of the \code{\linkS4class{BB7Copula}} (survival \code{sur}, 90 degree rotated \code{r90} and 270 degree rotated \code{r270}) family for a given parameter.
Modified: pkg/man/BB8Copula-class.Rd
===================================================================
--- pkg/man/BB8Copula-class.Rd 2013-04-04 17:50:25 UTC (rev 90)
+++ pkg/man/BB8Copula-class.Rd 2013-04-05 10:53:10 UTC (rev 91)
@@ -30,7 +30,7 @@
\title{Classes \code{"BB8Copula"}, \code{"surBB8Copula"}, \code{"r90BB8Copula"} and \code{"r270BB8Copula"}}
\description{
-Wrapper classes representing the BB8, survial BB8, 90 degree and 270 degree rotated BB8 copula families (Joe 1997) from the \code{\link{VineCopula-package}} package.
+Wrapper classes representing the BB8, survival BB8, 90 degree and 270 degree rotated BB8 copula families (Joe 1997) from the \code{\link{VineCopula-package}} package.
}
\section{Objects from the Classes}{
Objects can be created by calls of the form \code{new("BB8Copula", ...)}, \code{new("surBB8Copula", ...)}, \code{new("r90BB8Copula", ...)} and \code{new("r270BB8Copula", ...)} or by the functions \code{\link{BB8Copula}}, \code{\link{surBB8Copula}}, \code{\link{r90BB8Copula}} and \code{\link{r270BB8Copula}}.
Modified: pkg/man/BB8Copula.Rd
===================================================================
--- pkg/man/BB8Copula.Rd 2013-04-04 17:50:25 UTC (rev 90)
+++ pkg/man/BB8Copula.Rd 2013-04-05 10:53:10 UTC (rev 91)
@@ -5,7 +5,7 @@
\alias{r270BB8Copula}
\title{
-Constructor of the BB8 family and its derivates
+Constructor of the BB8 family and its derivatives
}
\description{
Constructs an object of the \code{\linkS4class{BB8Copula}} (survival \code{sur}, 90 degree rotated \code{r90} and 270 degree rotated \code{r270}) family for a given parameter.
Modified: pkg/man/asCopula.Rd
===================================================================
--- pkg/man/asCopula.Rd 2013-04-04 17:50:25 UTC (rev 90)
+++ pkg/man/asCopula.Rd 2013-04-05 10:53:10 UTC (rev 91)
@@ -19,7 +19,7 @@
Example 3.16 in: Nelsen, Roger B. (2006): An Introduction to Copulas, second edition, Springer
}
\author{
-Benedikt Gr{\'a}ler
+Benedikt Graeler
}
\seealso{
Modified: pkg/man/calcBins.Rd
===================================================================
--- pkg/man/calcBins.Rd 2013-04-04 17:50:25 UTC (rev 90)
+++ pkg/man/calcBins.Rd 2013-04-05 10:53:10 UTC (rev 91)
@@ -9,7 +9,7 @@
A function calculating the spatial/spatio-temporal bins
}
\description{
-The (spatio-temporal) space is subdivided into pairs of observations that belkopng to certain spatial/spatio-temporal distanxce classes. For each distance class, the mean separating distance of all pairs involved is calcualted alongside a correaltion measure. The spatial/spatio-temporal correlogram is plotted by default.
+The (spatio-temporal) space is subdivided into pairs of observations that belong to certain spatial/spatio-temporal distance classes. For each distance class, the mean separating distance of all pairs involved is calculated alongside a correlation measure. The spatial/spatio-temporal correlogram is plotted by default.
}
\usage{
calcBins(data, var, nbins = 15, boundaries = NA, cutoff = NA, cor.method="kendall", plot=T, ...)
@@ -20,7 +20,7 @@
Either some spatial \code{data.frame} extending \code{\link[sp:Spatial-class]{Spatial}} or a spatio-temporal \code{data.frame} extending \code{\linkS4class{ST}}.
}
\item{var}{
-A vector containing the variable names of interset to select a subset of the variables present in the data slot.
+A vector containing the variable names of interest to select a subset of the variables present in the data slot.
}
\item{nbins}{
the number of spatial bins.
@@ -29,24 +29,24 @@
The left hand-side limits of the lag classes to be investigated, if set to \code{NA}, the \code{cutoff} will be split in equal parts according to \code{nbins}.
}
\item{cutoff}{
-The largest spatial distance to be investiagted, if set to \code{NA}, one third of the boundingbox's diagonal will be used.
+The largest spatial distance to be investigated, if set to \code{NA}, one third of the bounding box's diagonal will be used.
}
\item{cor.method}{
defining the correlation method that should be used. Possible choices are \code{kendall} (default), \code{pearson}, \code{spearman} and \code{fasttau} that re-uses a very fast implementation of Kendall's tau from \code{\link{VineCopula-package}}.
}
\item{plot}{Whether the correlogram should be plotted.}
- \item{\dots}{Additioanl arguments for the spatio-temporal case:
+ \item{\dots}{Additional arguments for the spatio-temporal case:
\describe{
- \item{instances}{To reduce the data size or circumvent unwanted autocorrelation effects, one might provide a number of randomly selected time instances from the spatio-temporal \code{data.frame}. If this parameter is set to \code{NA}, th complete time series will be used, if different from a signle number, \code{instances} will be passed on as to index time.}
+ \item{instances}{To reduce the data size or circumvent unwanted autocorrelation effects, one might provide a number of randomly selected time instances from the spatio-temporal \code{data.frame}. If this parameter is set to \code{NA}, the complete time series will be used, if different from a single number, \code{instances} will be passed on as to index time.}
\item{t.lags}{a vector indicating the time lags to be investigated}
}
}
}
-\value{A list containg the following entries
+\value{A list containing the following entries
\item{meanDists}{A vector holding the mean separating distance for each lag.}
\item{lagCor}{A vector holding the calculated correlation measure for each lag.}
\item{lagData}{the data pairs for each lag}
-\item{lags}{In the spatial case, a vector holding the indicies of loactions used for each lag. In the spatio-temporal case, a list with a vector of spatail and temporal indicies used in the lag classes each.}
+\item{lags}{In the spatial case, a vector holding the indices of locations used for each lag. In the spatio-temporal case, a list with a vector of spatial and temporal indices used in the lag classes each.}
}
\author{
Modified: pkg/man/composeSpCopula.Rd
===================================================================
--- pkg/man/composeSpCopula.Rd 2013-04-04 17:50:25 UTC (rev 90)
+++ pkg/man/composeSpCopula.Rd 2013-04-05 10:53:10 UTC (rev 91)
@@ -4,14 +4,14 @@
Composing a bivariate Spatial Copula
}
\description{
-A bivaraite spatial copula is composed out of a set of bivariate copulas. These are combined uisng a convex linear combination with weights based on distances where for copulas with a 1-1 correspondence of Kendall's tau or Spearman's rho a dependence function providing measures of association based on distances might be used.
+A bivariate spatial copula is composed out of a set of bivariate copulas. These are combined using a convex linear combination with weights based on distances where for copulas with a 1-1 correspondence of Kendall's tau or Spearman's rho a dependence function providing measures of association based on distances might be used.
}
\usage{
composeSpCopula(bestFit, families, bins, calcCor, range=max(bins$meanDists))
}
\arguments{
\item{bestFit}{
-A vector indicating the best fitting copula family index (as in \code{families}) per lag-class. If this vector is shorter than the sactula number of bins, only these first bins will be used. It is an alternative way of setting a range.
+A vector indicating the best fitting copula family index (as in \code{families}) per lag-class. If this vector is shorter than the actual number of bins, only these first bins will be used. It is an alternative way of setting a range.
}
\item{families}{
The list of investigated families.
Added: pkg/man/condSpVine.Rd
===================================================================
--- pkg/man/condSpVine.Rd (rev 0)
+++ pkg/man/condSpVine.Rd 2013-04-05 10:53:10 UTC (rev 91)
@@ -0,0 +1,60 @@
+\name{condSpVine}
+\alias{condSpVine}
+
+\title{
+Conditions a spatial vine copula for conditional prediction
+}
+\description{
+A spatial vine copula is conditioned under the observations of all but one neighbour generating a conditional uivariate distribution used ofr prediction.
+}
+\usage{
+condSpVine(condVar, dists, spVine, n = 100)
+}
+\arguments{
+ \item{condVar}{
+the conditional variables
+}
+ \item{dists}{
+the distances between the neighbours to adjust the spatial vine copula parameters.
+}
+ \item{spVine}{
+the spatial vine copula
+}
+ \item{n}{
+a proxy to the number of intervals to be used in the numerical integration. The intervals will not be split uniform with a shorter intervals at the corners of the copula.
+}
+}
+\value{
+A function describing the conditional density.
+}
+\author{
+Benedikt Graeler
+}
+
+\seealso{
+\code{\linkS4class{spVineCopula}}
+}
+\examples{
+data(spCopDemo)
+
+calcKTauPol <- fitCorFun(bins, degree=3)
+
+spCop <- spCopula(components=list(normalCopula(0), tCopula(0, dispstr = "un"),
+ frankCopula(1), normalCopula(0), claytonCopula(0),
+ claytonCopula(0), claytonCopula(0), claytonCopula(0),
+ claytonCopula(0), indepCopula()),
+ distances=bins$meanDists,
+ spDepFun=calcKTauPol, unit="m")
+
+spVineCop <- spVineCopula(spCop, vineCopula(4L))
+
+dists <- runif(4,0,800)
+condVar <- runif(4)
+condDensity <- condSpVine(condVar,dists,spVineCop)
+
+curve(condDensity)
+mtext(paste("Dists:",paste(round(dists,0),collapse=", ")),line=0)
+mtext(paste("Cond.:",paste(round(condVar,2),collapse=", ")),line=1)
+}
+
+\keyword{ distribution }
Modified: pkg/man/copulaFromFamilyIndex.Rd
===================================================================
--- pkg/man/copulaFromFamilyIndex.Rd 2013-04-04 17:50:25 UTC (rev 90)
+++ pkg/man/copulaFromFamilyIndex.Rd 2013-04-05 10:53:10 UTC (rev 91)
@@ -1,7 +1,7 @@
\name{copulaFromFamilyIndex}
\alias{copulaFromFamilyIndex}
\title{
-Construct a copual object from a VineCopula family index
+Construct a copula object from a \code{\link{VineCopula-package}} family index
}
\description{
A \code{\linkS4class{copula}} object is constructed from the family index used in the package \code{\link{VineCopula-package}} for the provided parameters.
Modified: pkg/man/criticalLevel.Rd
===================================================================
--- pkg/man/criticalLevel.Rd 2013-04-04 17:50:25 UTC (rev 90)
+++ pkg/man/criticalLevel.Rd 2013-04-05 10:53:10 UTC (rev 91)
@@ -5,20 +5,20 @@
}
\description{
The critical level corresponding to a given Kendall Return Period and a given
-kendall distribution or its underlying copula.
+Kendall distribution or its underlying copula.
}
\usage{
criticalLevel(kendallFun = NULL, KRP = c(100, 1000), mu = 1, copula = NULL)
}
\arguments{
\item{kendallFun}{
-The kendall distribution function.
+The Kendall distribution function.
}
\item{KRP}{
-The desired Kendall Return Period(s); the feault are 100 and 1000.
+The desired Kendall Return Period(s); the default are 100 and 1000.
}
\item{mu}{
-The reoccurence of an event per time unit; the default is 1.
+The recurrence of an event per time unit; the default is 1.
}
\item{copula}{
The copula describing the dependencies between the investigated variables. Only necessary if \code{kendallFun} is not provided.
Modified: pkg/man/criticalPair.Rd
===================================================================
--- pkg/man/criticalPair.Rd 2013-04-04 17:50:25 UTC (rev 90)
+++ pkg/man/criticalPair.Rd 2013-04-05 10:53:10 UTC (rev 91)
@@ -1,7 +1,7 @@
\name{criticalPair}
\alias{criticalPair}
\title{
-Calculate Crtitical Pairs
+Calculate Critical Pairs
}
\description{
For a given argument, the second argument is calculated for a given critical level (cumulated probability level) and copula.
@@ -11,7 +11,7 @@
}
\arguments{
\item{copula}{
-The three-dimesnional copula.
+The three-dimensional copula.
}
\item{cl}{
The critical level (cumulative probability level).
@@ -27,7 +27,7 @@
}
}
\value{
-The second argument for which the geiven critical level (cumulative probability level) is achieved.
+The second argument for which the given critical level (cumulative probability level) is achieved.
}
\author{
Benedikt Graeler
Modified: pkg/man/criticalTriple.Rd
===================================================================
--- pkg/man/criticalTriple.Rd 2013-04-04 17:50:25 UTC (rev 90)
+++ pkg/man/criticalTriple.Rd 2013-04-05 10:53:10 UTC (rev 91)
@@ -11,7 +11,7 @@
}
\arguments{
\item{copula}{
-The three-dimesnional copula.
+The three-dimensional copula.
}
\item{cl}{
The critical level (cumulative probability level).
@@ -27,7 +27,7 @@
}
}
\value{
-The third argument for which the geiven critical level (cumulative probability level) is achieved.
+The third argument for which the given critical level (cumulative probability level) is achieved.
}
\author{
Benedikt Graeler
Modified: pkg/man/dduCopula.Rd
===================================================================
--- pkg/man/dduCopula.Rd 2013-04-04 17:50:25 UTC (rev 90)
+++ pkg/man/dduCopula.Rd 2013-04-05 10:53:10 UTC (rev 91)
@@ -6,7 +6,7 @@
partial derivatives of copulas
}
\description{
-Similair to the \code{\link{dCopula}} and \code{\link{pCopula}} the function \code{dduCopula} evaluates the partial derivative \eqn{\frac{\partial}{\partial u} C(u,v)} and the function \code{ddvCopula} evaluates the partial derivative \eqn{\frac{\partial}{\partial v} C(u,v)} of the provided copula.
+Similar to the \code{\link{dCopula}} and \code{\link{pCopula}} the function \code{dduCopula} evaluates the partial derivative \eqn{\frac{\partial}{\partial u} C(u,v)} and the function \code{ddvCopula} evaluates the partial derivative \eqn{\frac{\partial}{\partial v} C(u,v)} of the provided copula.
}
\usage{
dduCopula(u, copula, ...)
@@ -20,10 +20,10 @@
\item{copula}{
The copula object representing the family member of interest.
}
- \item{\dots}{additioanl arguments can be passed on to the underlying functions.}
+ \item{\dots}{additional arguments can be passed on to the underlying functions.}
}
\value{
-A vector of the evaluated partial derivaitves of the same length as rows in \code{u}.
+A vector of the evaluated partial derivatives of the same length as rows in \code{u}.
}
\author{
Benedikt Graeler
Modified: pkg/man/dependencePlot.Rd
===================================================================
--- pkg/man/dependencePlot.Rd 2013-04-04 17:50:25 UTC (rev 90)
+++ pkg/man/dependencePlot.Rd 2013-04-05 10:53:10 UTC (rev 91)
@@ -1,10 +1,10 @@
\name{dependencePlot}
\alias{dependencePlot}
\title{
-Kernel smoothed scatterplot
+Kernel smoothed scatter plot
}
\description{
-Plots a kernel smoothed scatterplot of the provided rank-transformed sample. The work is done by the function \code{\link{panel.smoothScatter}}.
+Plots a kernel smoothed scatter plot of the provided rank-transformed sample. The work is done by the function \code{\link{panel.smoothScatter}}.
}
\usage{
dependencePlot(var = NULL, smpl, bandwidth = 0.075, main="Stength of dependece", transformation = function(x) x, ...)
@@ -21,7 +21,7 @@
the bandwidth passed to the smoothing kernel
}
\item{main}{
-the tilte of the plot
+the title of the plot
}
\item{transformation}{
a transformation passed to the kernel
Modified: pkg/man/empiricalCopula-class.Rd
===================================================================
--- pkg/man/empiricalCopula-class.Rd 2013-04-04 17:50:25 UTC (rev 90)
+++ pkg/man/empiricalCopula-class.Rd 2013-04-05 10:53:10 UTC (rev 91)
@@ -28,7 +28,7 @@
Class \code{"\linkS4class{Copula}"}, by class "copula", distance 2.
}
\section{Methods}{
-No additional methods defined with class "empiricalCopula" in the signature, but \code{\link{pCopula}} works as expected.
+No additional methods defined with class \code{empiricalCopula} in the signature, but \code{\link{pCopula}} works as expected.
}
\author{
Benedikt Graeler}
Modified: pkg/man/empiricalCopula.Rd
===================================================================
--- pkg/man/empiricalCopula.Rd 2013-04-04 17:50:25 UTC (rev 90)
+++ pkg/man/empiricalCopula.Rd 2013-04-05 10:53:10 UTC (rev 91)
@@ -1,7 +1,7 @@
\name{empiricalCopula}
\alias{empiricalCopula}
\title{
-Constructor of an empircal copula class
+Constructor of an empirical copula class
}
\description{
Constructs an object of the empirical copula class \code{\linkS4class{empiricalCopula}}, see \code{\link{genEmpCop}} for a simplified version.
@@ -14,7 +14,7 @@
A sample from a provided or unknown copula family.
}
\item{copula}{
-The underlying theoretical copula, in case it is known or a sample should be gnerated.
+The underlying theoretical copula, in case it is known or a sample should be generated.
}
}
\value{
@@ -28,7 +28,7 @@
}
\seealso{
-\code{\link{genEmpCop}} for a simplified constructor with sample length controle.
+\code{\link{genEmpCop}} for a simplified constructor with sample length control.
}
\examples{
empCop <- empiricalCopula(rCopula(500,frankCopula(0.7)))
Modified: pkg/man/fitCorFun.Rd
===================================================================
--- pkg/man/fitCorFun.Rd 2013-04-04 17:50:25 UTC (rev 90)
+++ pkg/man/fitCorFun.Rd 2013-04-05 10:53:10 UTC (rev 91)
@@ -5,7 +5,7 @@
Automated fitting of a correlation function to the correlogram
}
\description{
-Polynomials of different degrees can be fitteds to the correlogram calculated using \code{\link{calcBins}}. This function will be used to adjust the copula parameter in the spatial/spatio-temporal copula.
+Polynomials of different degrees can be fitted to the correlogram calculated using \code{\link{calcBins}}. This function will be used to adjust the copula parameter in the spatial/spatio-temporal copula.
}
\usage{
fitCorFun(bins, degree = 3, cutoff = NA, bounds = c(0, 1), cor.method = NULL)
@@ -15,10 +15,10 @@
Typically the output of \code{\link{calcBins}}. Any \code{data.frame} with a columns \code{lagCor} and \code{meanDists} in the first two columns will do.
}
\item{degree}{
-The degree of polynominal to be fitted.
+The degree of polynomial to be fitted.
}
\item{cutoff}{
-Maximal distance to which lags should be included in the polynominal fit.
+Maximal distance to which lags should be included in the polynomial fit.
}
\item{bounds}{
Bounds of the correlation values. The default is set [0,1] not allowing any negative relationship but perfect positive dependence.
@@ -28,7 +28,7 @@
}
}
\value{
-Returns a function that provides correlation estimate for every seperating distance.
+Returns a function that provides correlation estimate for every separating distance.
}
\author{
Benedikt Graeler
Modified: pkg/man/fitSpCopula.Rd
===================================================================
--- pkg/man/fitSpCopula.Rd 2013-04-04 17:50:25 UTC (rev 90)
+++ pkg/man/fitSpCopula.Rd 2013-04-05 10:53:10 UTC (rev 91)
@@ -5,17 +5,17 @@
Spatial Copula Fitting
}
\description{
-A bivaraite spatial copula is composed out of a set of bivariate copulas. These are combined uisng a convex linear combination with weights based on distances where for copulas with a 1-1 correspondence of Kendall's tau or Spearman's rho a dependence function providing measures of association based on distances might be used. This function estimates a spatial dependence function, evaluates the loglikelihood per family and lag class, selects the bist fits and composes a spatial bivariate copula.
+A bivariate spatial copula is composed out of a set of bivariate copulas. These are combined using a convex linear combination with weights based on distances where for copulas with a 1-1 correspondence of Kendall's tau or Spearman's rho a dependence function providing measures of association based on distances might be used. This function estimates a spatial dependence function, evaluates the log-likelihood per family and lag class, selects the best fits and composes a spatial bivariate copula.
}
\usage{
fitSpCopula(bins, cutoff = NA, families = c(normalCopula(0), tCopula(0, dispstr = "un"), claytonCopula(0), frankCopula(1), gumbelCopula(1)), ...)
}
\arguments{
\item{bins}{
-the bins to be used, typically outpout from \"calcBins\".
+the bins to be used, typically output from \code{\link{calcBins}}.
}
\item{cutoff}{
-The maximal distance to be used in the fitment.
+The maximal distance to be used in the fit.
}
\item{families}{
The set of families to be investigated.
Modified: pkg/man/genEmpCop.Rd
===================================================================
--- pkg/man/genEmpCop.Rd 2013-04-04 17:50:25 UTC (rev 90)
+++ pkg/man/genEmpCop.Rd 2013-04-05 10:53:10 UTC (rev 91)
@@ -11,7 +11,7 @@
}
\arguments{
\item{copula}{
-The theoretical copula to be represnted numerically.
+The theoretical copula to be represented numerically.
}
\item{sample.size}{
The length of the sample to be used. The default is 1e5.
Modified: pkg/man/genEmpKenFun.Rd
===================================================================
--- pkg/man/genEmpKenFun.Rd 2013-04-04 17:50:25 UTC (rev 90)
+++ pkg/man/genEmpKenFun.Rd 2013-04-05 10:53:10 UTC (rev 91)
@@ -1,10 +1,10 @@
\name{genEmpKenFun}
\alias{genEmpKenFun}
\title{
-Generates an emprical Kendall distribution function
+Generates an empirical Kendall distribution function
}
\description{
-Generates an emprical Kendall distribution function in cases where no closed form exists. When a sample is provided (\code{smpl}) this exact sample is used to derive the empirical Kendall distribution function. Otherweise, a sample will be generated from the porovided copula.
+Generates an empirical Kendall distribution function in cases where no closed form exists. When a sample is provided (\code{smpl}) this exact sample is used to derive the empirical Kendall distribution function. Otherwise, a sample will be generated from the provided copula.
}
\usage{
genEmpKenFun(copula, sample = NULL)
@@ -14,11 +14,11 @@
The underlying copula from which 1e6 samples are drawn by default.
}
\item{sample}{
-Optional, a specific sample that should be used to generate the emopircal Kendall distribution function.
+Optional, a specific sample that should be used to generate the empirical Kendall distribution function.
}
}
\value{
-A function returning the corresponding empirical Kendalll distribution value.
+A function returning the corresponding empirical Kendall distribution value.
}
\author{
Benedikt Graeler
Modified: pkg/man/getKendallDistr.Rd
===================================================================
--- pkg/man/getKendallDistr.Rd 2013-04-04 17:50:25 UTC (rev 90)
+++ pkg/man/getKendallDistr.Rd 2013-04-05 10:53:10 UTC (rev 91)
@@ -5,10 +5,10 @@
\alias{getKendallDistr,gumbelCopula-method}
\title{
-retrieveing the Kendall Distribuiton function for a given copula
+retrieving the Kendall Distribution function for a given copula
}
\description{
-Depending on the copula passed, an analytical or empircal Kendall distribution function (\code{\link{kendallDistribution}}) is returned.
+Depending on the copula passed, an analytical or empirical Kendall distribution function (\code{\link{kendallDistribution}}) is returned.
}
\usage{
getKendallDistr(copula, sample = NULL)
@@ -18,7 +18,7 @@
A copula object.
}
\item{sample}{
[TRUNCATED]
To get the complete diff run:
svnlook diff /svnroot/spcopula -r 91
More information about the spcopula-commits
mailing list