id
stringlengths 40
40
| repo_name
stringlengths 5
110
| path
stringlengths 2
233
| content
stringlengths 0
1.03M
⌀ | size
int32 0
60M
⌀ | license
stringclasses 15
values |
|---|---|---|---|---|---|
2db475fa991cd0661f0f4ca2203821d40ed06a7f
|
mirror/r
|
src/library/stats/man/residuals.Rd
|
% File src/library/stats/man/residuals.Rd
% Part of the R package, http://www.R-project.org
% Copyright 1995-2013 R Core Team
% Distributed under GPL 2 or later
\name{residuals}
\alias{residuals}
\alias{resid}
%\alias{residuals.default}
\title{Extract Model Residuals}
\usage{
residuals(object, \dots)
resid(object, \dots)
}
\arguments{
\item{object}{an object for which the extraction of model residuals is
meaningful.}
\item{\dots}{other arguments.}
}
\value{
Residuals extracted from the object \code{object}.
}
\description{
\code{residuals} is a generic function which extracts model residuals
from objects returned by modeling functions.
The abbreviated form \code{resid} is an alias for \code{residuals}.
It is intended to encourage users to access object components through
an accessor function rather than by directly referencing an object
slot.
All object classes which are returned by model fitting functions
should provide a \code{residuals} method. (Note that the method is
for \samp{residuals} and not \samp{resid}.)
Methods can make use of \code{\link{naresid}} methods to compensate
for the omission of missing values. The default, \code{\link{nls}} and
\code{\link{smooth.spline}} methods do.
}
\references{
Chambers, J. M. and Hastie, T. J. (1992)
\emph{Statistical Models in S}.
Wadsworth & Brooks/Cole.
}
\seealso{
\code{\link{coefficients}}, \code{\link{fitted.values}},
\code{\link{glm}}, \code{\link{lm}}.
\link{influence.measures} for standardized (\code{\link{rstandard}})
and studentized (\code{\link{rstudent}}) residuals.
}
\keyword{models}
\keyword{regression}
| 1,645 |
gpl-2.0
|
2db475fa991cd0661f0f4ca2203821d40ed06a7f
|
jeffreyhorner/R-Array-Hash
|
src/library/stats/man/residuals.Rd
|
% File src/library/stats/man/residuals.Rd
% Part of the R package, http://www.R-project.org
% Copyright 1995-2013 R Core Team
% Distributed under GPL 2 or later
\name{residuals}
\alias{residuals}
\alias{resid}
%\alias{residuals.default}
\title{Extract Model Residuals}
\usage{
residuals(object, \dots)
resid(object, \dots)
}
\arguments{
\item{object}{an object for which the extraction of model residuals is
meaningful.}
\item{\dots}{other arguments.}
}
\value{
Residuals extracted from the object \code{object}.
}
\description{
\code{residuals} is a generic function which extracts model residuals
from objects returned by modeling functions.
The abbreviated form \code{resid} is an alias for \code{residuals}.
It is intended to encourage users to access object components through
an accessor function rather than by directly referencing an object
slot.
All object classes which are returned by model fitting functions
should provide a \code{residuals} method. (Note that the method is
for \samp{residuals} and not \samp{resid}.)
Methods can make use of \code{\link{naresid}} methods to compensate
for the omission of missing values. The default, \code{\link{nls}} and
\code{\link{smooth.spline}} methods do.
}
\references{
Chambers, J. M. and Hastie, T. J. (1992)
\emph{Statistical Models in S}.
Wadsworth & Brooks/Cole.
}
\seealso{
\code{\link{coefficients}}, \code{\link{fitted.values}},
\code{\link{glm}}, \code{\link{lm}}.
\link{influence.measures} for standardized (\code{\link{rstandard}})
and studentized (\code{\link{rstudent}}) residuals.
}
\keyword{models}
\keyword{regression}
| 1,645 |
gpl-2.0
|
b165134c9e68aa23d31652772a3f6c0a098ff975
|
agoldst/dfrtopics
|
man/wordcounts_instances.Rd
|
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/instances.R
\name{wordcounts_instances}
\alias{wordcounts_instances}
\title{Create MALLET instances from a word-counts data frame}
\usage{
wordcounts_instances(
counts,
shuffle = FALSE,
sep = " ",
token_regex = "\\\\S+",
preserve_case = TRUE
)
}
\arguments{
\item{counts}{data frame with \code{id}, \code{word}, \code{weight} columns}
\item{shuffle}{randomize word order before passing on to MALLET? (See
\code{\link{wordcounts_texts}}}
\item{sep}{separator to use between words}
\item{token_regex}{regular expression matching a token. Ordinarily, this
should correspond to \code{sep} (hence the default, whitespace
tokenization), since no further tokenization should be done.}
\item{preserve_case}{if FALSE, all words are lowercased by MALLET}
}
\value{
an rJava reference to a MALLET \code{InstanceList}
}
\description{
Given a data frame representing documents as feature counts, create a MALLET
\code{InstanceList} object which can then be passed on to
\code{\link{train_model}} or saved to disk for later use with
\code{\link{write_instances}}. This function is a small convenience wrapper
for \code{\link{make_instances}} that ensures no further stopword removal,
tokenization, or casefolding is done.
}
\details{
If your tokens themselves contain whitespace, change the \code{sep} parameter
and adjust the \code{token_regex} accordingly.
}
\seealso{
\code{\link{make_instances}} which this wraps,
\code{\link{train_model}}, \code{\link{write_instances}}
}
| 1,565 |
mit
|
2db475fa991cd0661f0f4ca2203821d40ed06a7f
|
hadley/r-source
|
src/library/stats/man/residuals.Rd
|
% File src/library/stats/man/residuals.Rd
% Part of the R package, http://www.R-project.org
% Copyright 1995-2013 R Core Team
% Distributed under GPL 2 or later
\name{residuals}
\alias{residuals}
\alias{resid}
%\alias{residuals.default}
\title{Extract Model Residuals}
\usage{
residuals(object, \dots)
resid(object, \dots)
}
\arguments{
\item{object}{an object for which the extraction of model residuals is
meaningful.}
\item{\dots}{other arguments.}
}
\value{
Residuals extracted from the object \code{object}.
}
\description{
\code{residuals} is a generic function which extracts model residuals
from objects returned by modeling functions.
The abbreviated form \code{resid} is an alias for \code{residuals}.
It is intended to encourage users to access object components through
an accessor function rather than by directly referencing an object
slot.
All object classes which are returned by model fitting functions
should provide a \code{residuals} method. (Note that the method is
for \samp{residuals} and not \samp{resid}.)
Methods can make use of \code{\link{naresid}} methods to compensate
for the omission of missing values. The default, \code{\link{nls}} and
\code{\link{smooth.spline}} methods do.
}
\references{
Chambers, J. M. and Hastie, T. J. (1992)
\emph{Statistical Models in S}.
Wadsworth & Brooks/Cole.
}
\seealso{
\code{\link{coefficients}}, \code{\link{fitted.values}},
\code{\link{glm}}, \code{\link{lm}}.
\link{influence.measures} for standardized (\code{\link{rstandard}})
and studentized (\code{\link{rstudent}}) residuals.
}
\keyword{models}
\keyword{regression}
| 1,645 |
gpl-2.0
|
2db475fa991cd0661f0f4ca2203821d40ed06a7f
|
jagdeesh109/RRO
|
R-src/src/library/stats/man/residuals.Rd
|
% File src/library/stats/man/residuals.Rd
% Part of the R package, http://www.R-project.org
% Copyright 1995-2013 R Core Team
% Distributed under GPL 2 or later
\name{residuals}
\alias{residuals}
\alias{resid}
%\alias{residuals.default}
\title{Extract Model Residuals}
\usage{
residuals(object, \dots)
resid(object, \dots)
}
\arguments{
\item{object}{an object for which the extraction of model residuals is
meaningful.}
\item{\dots}{other arguments.}
}
\value{
Residuals extracted from the object \code{object}.
}
\description{
\code{residuals} is a generic function which extracts model residuals
from objects returned by modeling functions.
The abbreviated form \code{resid} is an alias for \code{residuals}.
It is intended to encourage users to access object components through
an accessor function rather than by directly referencing an object
slot.
All object classes which are returned by model fitting functions
should provide a \code{residuals} method. (Note that the method is
for \samp{residuals} and not \samp{resid}.)
Methods can make use of \code{\link{naresid}} methods to compensate
for the omission of missing values. The default, \code{\link{nls}} and
\code{\link{smooth.spline}} methods do.
}
\references{
Chambers, J. M. and Hastie, T. J. (1992)
\emph{Statistical Models in S}.
Wadsworth & Brooks/Cole.
}
\seealso{
\code{\link{coefficients}}, \code{\link{fitted.values}},
\code{\link{glm}}, \code{\link{lm}}.
\link{influence.measures} for standardized (\code{\link{rstandard}})
and studentized (\code{\link{rstudent}}) residuals.
}
\keyword{models}
\keyword{regression}
| 1,645 |
gpl-2.0
|
2db475fa991cd0661f0f4ca2203821d40ed06a7f
|
ChiWang/r-source
|
src/library/stats/man/residuals.Rd
|
% File src/library/stats/man/residuals.Rd
% Part of the R package, http://www.R-project.org
% Copyright 1995-2013 R Core Team
% Distributed under GPL 2 or later
\name{residuals}
\alias{residuals}
\alias{resid}
%\alias{residuals.default}
\title{Extract Model Residuals}
\usage{
residuals(object, \dots)
resid(object, \dots)
}
\arguments{
\item{object}{an object for which the extraction of model residuals is
meaningful.}
\item{\dots}{other arguments.}
}
\value{
Residuals extracted from the object \code{object}.
}
\description{
\code{residuals} is a generic function which extracts model residuals
from objects returned by modeling functions.
The abbreviated form \code{resid} is an alias for \code{residuals}.
It is intended to encourage users to access object components through
an accessor function rather than by directly referencing an object
slot.
All object classes which are returned by model fitting functions
should provide a \code{residuals} method. (Note that the method is
for \samp{residuals} and not \samp{resid}.)
Methods can make use of \code{\link{naresid}} methods to compensate
for the omission of missing values. The default, \code{\link{nls}} and
\code{\link{smooth.spline}} methods do.
}
\references{
Chambers, J. M. and Hastie, T. J. (1992)
\emph{Statistical Models in S}.
Wadsworth & Brooks/Cole.
}
\seealso{
\code{\link{coefficients}}, \code{\link{fitted.values}},
\code{\link{glm}}, \code{\link{lm}}.
\link{influence.measures} for standardized (\code{\link{rstandard}})
and studentized (\code{\link{rstudent}}) residuals.
}
\keyword{models}
\keyword{regression}
| 1,645 |
gpl-2.0
|
9668d833386256a56fe4bd15ddb9c9707df78ced
|
Accenture/timeseriesr
|
man/calc_area.Rd
|
% Generated by roxygen2 (4.0.2): do not edit by hand
\name{calc_area}
\alias{calc_area}
\title{Calculate Area Under the Curve}
\usage{
calc_area(time_date, value, unit_conversion = 1, as_vector = FALSE,
diff_time = FALSE, neg_area = FALSE, na.replace = vreplace, ...)
}
\arguments{
\item{time_date}{A numeric or date.time vector}
\item{value}{A numeric vector}
\item{unit_conversion}{The ratio of your variable to time. Be cautious of this unless inaccurate results appease you :)}
\item{as_vector}{Boolean describing if return value should be the totaled sum or a vector representing area at each `time` value}
\item{diff_time}{Boolean describing if `time` is the difference in area, or if it needs to be calculated}
\item{neg_area}{Boolean describing if negative area should be measured or it all area is positive}
\item{na.replace}{Function that replaces NA values from `value` with Last Observation Carried Forward. See \code{\link{vreplace}}}
}
\value{
The total area under the curve of `value` with respect to the time measured at `time`
}
\description{
This function takes two vectors, a time-date vector and a numeric vector and performs computations to measure to total area
under the curve. Its apprach is to use Reimann Left Sums is and aimed towards time-series data
}
\examples{
time <- 1:10
value <- sin(1:10)
calc_area(time, value)
calc_area(time, value, TRUE)
calc_area(time, value, diff_time = TRUE)
calc_area(time, value, neg_area = TRUE)
calc_area(time, value, TRUE, TRUE)
}
| 1,510 |
mit
|
24d611e4b5f7aa93fd3255a5e8c7028d135b7c9d
|
radfordneal/pqR
|
src/library/splines/man/periodicSpline.Rd
|
% File src/library/splines/man/periodicSpline.Rd
% Part of the R package, http://www.R-project.org
% Copyright 1995-2007 R Core Team
% Distributed under GPL 2 or later
\name{periodicSpline}
\alias{periodicSpline}
\title{Create a Periodic Interpolation Spline}
\description{
Create a periodic interpolation spline, either from \code{x} and
\code{y} vectors, or from a formula/data.frame combination.
}
\usage{
periodicSpline(obj1, obj2, knots, period = 2*pi, ord = 4)
}
\arguments{
\item{obj1}{either a numeric vector of \code{x} values or a formula.}
\item{obj2}{if \code{obj1} is numeric this should be a numeric vector
of the same length. If \code{obj1} is a formula this can be an
optional data frame in which to evaluate the names in the formula.}
\item{knots}{optional numeric vector of knot positions.}
\item{period}{positive numeric value giving the period for the
periodic spline. Defaults to \code{2 * pi}.}
\item{ord}{integer giving the order of the spline, at least 2. Defaults
to 4. See \code{\link{splineOrder}} for a definition of the order of
a spline.}
}
\value{
An object that inherits from class \code{spline}. The object can be in
the B-spline representation, in which case it will be a
\code{pbSpline} object, or in the piecewise polynomial representation
(a \code{ppolySpline} object).
}
\author{Douglas Bates and Bill Venables}
\seealso{
\code{\link{splineKnots}},
\code{\link{interpSpline}}
}
\examples{
require(graphics); require(stats)
xx <- seq( -pi, pi, length.out = 16 )[-1]
yy <- sin( xx )
frm <- data.frame( xx, yy )
pispl <- periodicSpline( xx, yy, period = 2 * pi)
\donttest{pispl}
pispl2 <- periodicSpline( yy ~ xx, frm, period = 2 * pi )
stopifnot(all.equal(pispl, pispl2))# pispl and pispl2 are the same
plot( pispl ) # displays over one period
points( yy ~ xx, col = "brown")
plot( predict( pispl, seq(-3*pi, 3*pi, length.out = 101) ), type = "l" )
}
\keyword{models}
| 1,956 |
gpl-2.0
|
c544b57b447a5ab250b8dbb0c887fddec4b09811
|
johngarvin/R-2.1.1rcc
|
src/library/datasets/man/PlantGrowth.Rd
|
\name{PlantGrowth}
\docType{data}
\alias{PlantGrowth}
\title{Results from an Experiment on Plant Growth}
\description{
Results from an experiment to compare yields (as measured by dried
weight of plants) obtained under a control and two different treatment
conditions.
}
\usage{PlantGrowth}
\format{
A data frame of 30 cases on 2 variables.
\tabular{rll}{
[, 1] \tab weight \tab numeric \cr
[, 2] \tab group \tab factor
}
The levels of \code{group} are \sQuote{ctrl}, \sQuote{trt1}, and \sQuote{trt2}.
}
\examples{
## One factor ANOVA example from Dobson's book, cf. Table 7.4:
require(stats)
boxplot(weight ~ group, data = PlantGrowth, main = "PlantGrowth data",
ylab = "Dried weight of plants", col = "lightgray",
notch = TRUE, varwidth = TRUE)
anova(lm(weight ~ group, data = PlantGrowth))
}
\source{
Dobson, A. J. (1983)
\emph{An Introduction to Statistical Modelling}.
London: Chapman and Hall.
}
\keyword{datasets}
| 968 |
gpl-2.0
|
630ee246c5d3da7f122ff47a8ae22e25ff504334
|
kmiddleton/EulerBending
|
man/EulerBending-package.Rd
|
% Generated by roxygen2 (4.0.0): do not edit by hand
\docType{package}
\name{EulerBending-package}
\alias{EulerBending}
\alias{EulerBending-package}
\title{EulerBending}
\description{
\tabular{ll}{ Package: \tab EulerBending\cr
Type: \tab Package\cr
Version: \tab 0.0.1\cr
Date: \tab 2013-11-29\cr
License: \tab GPL-2\cr
LazyLoad: \tab yes\cr
LazyData: \tab yes\cr }
}
\author{
Kevin M. Middleton (\url{middletonk@missouri.edu})
}
\keyword{package}
| 534 |
gpl-2.0
|
868babfdad9a780d0304120b1656ffe1127f0403
|
mirror/r
|
src/library/methods/man/MethodWithNext-class.Rd
|
% File src/library/methods/man/MethodWithNext-class.Rd
% Part of the R package, http://www.R-project.org
% Copyright 1995-2007 R Core Team
% Distributed under GPL 2 or later
\name{MethodWithNext-class}
\docType{class}
\alias{MethodWithNext-class}
\title{Class MethodWithNext }
\description{ Class of method definitions set up for callNextMethod }
\section{Objects from the Class}{
Objects from this class are generated as a side-effect of calls to
\code{\link{callNextMethod}}.
}
\section{Slots}{
\describe{
\item{\code{.Data}:}{Object of class \code{"function"}; the actual
function definition.}
\item{\code{nextMethod}:}{Object of class \code{"PossibleMethod"}
the method to use in response to a \code{\link{callNextMethod}()}
call.}
\item{\code{excluded}:}{Object of class \code{"list"}; one or more
signatures excluded in finding the next method. }
\item{\code{target}:}{Object of class \code{"signature"}, from class
\code{"MethodDefinition"}}
\item{\code{defined}:}{Object of class \code{"signature"}, from
class \code{"MethodDefinition"}}
\item{\code{generic}:}{Object of class \code{"character"}; the function
for which the method was created. }
}
}
\section{Extends}{
Class \code{"MethodDefinition"}, directly.\cr
Class \code{"function"}, from data part.\cr
Class \code{"PossibleMethod"}, by class \code{"MethodDefinition"}.\cr
Class \code{"OptionalMethods"}, by class \code{"MethodDefinition"}.
}
\section{Methods}{
\describe{
\item{findNextMethod}{\code{signature(method = "MethodWithNext")}:
used internally by method dispatch. }
\item{loadMethod}{\code{signature(method = "MethodWithNext")}: used
internally by method dispatch. }
\item{show}{\code{signature(object = "MethodWithNext")} }
}
}
\seealso{ \code{\link{callNextMethod}}, and
class \code{\linkS4class{MethodDefinition}}.
}
\keyword{classes}
| 1,933 |
gpl-2.0
|
868babfdad9a780d0304120b1656ffe1127f0403
|
o-/Rexperiments
|
src/library/methods/man/MethodWithNext-class.Rd
|
% File src/library/methods/man/MethodWithNext-class.Rd
% Part of the R package, http://www.R-project.org
% Copyright 1995-2007 R Core Team
% Distributed under GPL 2 or later
\name{MethodWithNext-class}
\docType{class}
\alias{MethodWithNext-class}
\title{Class MethodWithNext }
\description{ Class of method definitions set up for callNextMethod }
\section{Objects from the Class}{
Objects from this class are generated as a side-effect of calls to
\code{\link{callNextMethod}}.
}
\section{Slots}{
\describe{
\item{\code{.Data}:}{Object of class \code{"function"}; the actual
function definition.}
\item{\code{nextMethod}:}{Object of class \code{"PossibleMethod"}
the method to use in response to a \code{\link{callNextMethod}()}
call.}
\item{\code{excluded}:}{Object of class \code{"list"}; one or more
signatures excluded in finding the next method. }
\item{\code{target}:}{Object of class \code{"signature"}, from class
\code{"MethodDefinition"}}
\item{\code{defined}:}{Object of class \code{"signature"}, from
class \code{"MethodDefinition"}}
\item{\code{generic}:}{Object of class \code{"character"}; the function
for which the method was created. }
}
}
\section{Extends}{
Class \code{"MethodDefinition"}, directly.\cr
Class \code{"function"}, from data part.\cr
Class \code{"PossibleMethod"}, by class \code{"MethodDefinition"}.\cr
Class \code{"OptionalMethods"}, by class \code{"MethodDefinition"}.
}
\section{Methods}{
\describe{
\item{findNextMethod}{\code{signature(method = "MethodWithNext")}:
used internally by method dispatch. }
\item{loadMethod}{\code{signature(method = "MethodWithNext")}: used
internally by method dispatch. }
\item{show}{\code{signature(object = "MethodWithNext")} }
}
}
\seealso{ \code{\link{callNextMethod}}, and
class \code{\linkS4class{MethodDefinition}}.
}
\keyword{classes}
| 1,933 |
gpl-2.0
|
6aeb5efb60c707a80aece087f9b207509929809a
|
ammaciel/stilf
|
man/lucC_toJSON.Rd
|
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/lucC_load_data.R
\docType{data}
\name{lucC_toJSON}
\alias{lucC_toJSON}
\title{Save result as JSON format}
\usage{
lucC_toJSON (data_tb, path_json_file = NULL)
}
\arguments{
\item{data_tb}{Tibble. A data frame with input values}
\item{path_json_file}{Character. Name path and file to save JSON file data}
}
\value{
JSON format to file stored
}
\description{
Save the output data in JSON format in an user's directory
}
\examples{
\dontrun{
library(lucC)
lucC_starting_point()
file_csv = "./data/example_TWDTW.csv"
input_tb_csv <- file_csv \%>\%
lucC_fromCSV(separator = ",", header_file = TRUE) #\%>\%
input_tb_csv
# save the input as json format
output_file = "~/Desktop/example_json.json"
lucC_toJSON(input_tb_csv, output_file)
}
}
\author{
Adeline M. Maciel
}
\keyword{datasets}
| 871 |
gpl-2.0
|
1c62e06114f7e24b9f2bf6c3dfc93bdf1155ef68
|
anqif/cvxr
|
man/curvature.Rd
|
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/generics.R
\docType{methods}
\name{curvature}
\alias{curvature}
\title{Curvature of Expression}
\usage{
curvature(object)
}
\arguments{
\item{object}{An \linkS4class{Expression} object.}
}
\value{
A string indicating the curvature of the expression, either "CONSTANT", "AFFINE", "CONVEX, "CONCAVE", or "UNKNOWN".
}
\description{
The curvature of an expression.
}
\examples{
x <- Variable()
c <- Constant(5)
curvature(c)
curvature(x)
curvature(x^2)
curvature(sqrt(x))
curvature(log(x^3) + sqrt(x))
}
| 578 |
apache-2.0
|
868babfdad9a780d0304120b1656ffe1127f0403
|
jeffreyhorner/R-Judy-Arrays
|
src/library/methods/man/MethodWithNext-class.Rd
|
% File src/library/methods/man/MethodWithNext-class.Rd
% Part of the R package, http://www.R-project.org
% Copyright 1995-2007 R Core Team
% Distributed under GPL 2 or later
\name{MethodWithNext-class}
\docType{class}
\alias{MethodWithNext-class}
\title{Class MethodWithNext }
\description{ Class of method definitions set up for callNextMethod }
\section{Objects from the Class}{
Objects from this class are generated as a side-effect of calls to
\code{\link{callNextMethod}}.
}
\section{Slots}{
\describe{
\item{\code{.Data}:}{Object of class \code{"function"}; the actual
function definition.}
\item{\code{nextMethod}:}{Object of class \code{"PossibleMethod"}
the method to use in response to a \code{\link{callNextMethod}()}
call.}
\item{\code{excluded}:}{Object of class \code{"list"}; one or more
signatures excluded in finding the next method. }
\item{\code{target}:}{Object of class \code{"signature"}, from class
\code{"MethodDefinition"}}
\item{\code{defined}:}{Object of class \code{"signature"}, from
class \code{"MethodDefinition"}}
\item{\code{generic}:}{Object of class \code{"character"}; the function
for which the method was created. }
}
}
\section{Extends}{
Class \code{"MethodDefinition"}, directly.\cr
Class \code{"function"}, from data part.\cr
Class \code{"PossibleMethod"}, by class \code{"MethodDefinition"}.\cr
Class \code{"OptionalMethods"}, by class \code{"MethodDefinition"}.
}
\section{Methods}{
\describe{
\item{findNextMethod}{\code{signature(method = "MethodWithNext")}:
used internally by method dispatch. }
\item{loadMethod}{\code{signature(method = "MethodWithNext")}: used
internally by method dispatch. }
\item{show}{\code{signature(object = "MethodWithNext")} }
}
}
\seealso{ \code{\link{callNextMethod}}, and
class \code{\linkS4class{MethodDefinition}}.
}
\keyword{classes}
| 1,933 |
gpl-2.0
|
1c62e06114f7e24b9f2bf6c3dfc93bdf1155ef68
|
bnaras/cvxr
|
man/curvature.Rd
|
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/generics.R
\docType{methods}
\name{curvature}
\alias{curvature}
\title{Curvature of Expression}
\usage{
curvature(object)
}
\arguments{
\item{object}{An \linkS4class{Expression} object.}
}
\value{
A string indicating the curvature of the expression, either "CONSTANT", "AFFINE", "CONVEX, "CONCAVE", or "UNKNOWN".
}
\description{
The curvature of an expression.
}
\examples{
x <- Variable()
c <- Constant(5)
curvature(c)
curvature(x)
curvature(x^2)
curvature(sqrt(x))
curvature(log(x^3) + sqrt(x))
}
| 578 |
gpl-2.0
|
868babfdad9a780d0304120b1656ffe1127f0403
|
radfordneal/pqR
|
src/library/methods/man/MethodWithNext-class.Rd
|
% File src/library/methods/man/MethodWithNext-class.Rd
% Part of the R package, http://www.R-project.org
% Copyright 1995-2007 R Core Team
% Distributed under GPL 2 or later
\name{MethodWithNext-class}
\docType{class}
\alias{MethodWithNext-class}
\title{Class MethodWithNext }
\description{ Class of method definitions set up for callNextMethod }
\section{Objects from the Class}{
Objects from this class are generated as a side-effect of calls to
\code{\link{callNextMethod}}.
}
\section{Slots}{
\describe{
\item{\code{.Data}:}{Object of class \code{"function"}; the actual
function definition.}
\item{\code{nextMethod}:}{Object of class \code{"PossibleMethod"}
the method to use in response to a \code{\link{callNextMethod}()}
call.}
\item{\code{excluded}:}{Object of class \code{"list"}; one or more
signatures excluded in finding the next method. }
\item{\code{target}:}{Object of class \code{"signature"}, from class
\code{"MethodDefinition"}}
\item{\code{defined}:}{Object of class \code{"signature"}, from
class \code{"MethodDefinition"}}
\item{\code{generic}:}{Object of class \code{"character"}; the function
for which the method was created. }
}
}
\section{Extends}{
Class \code{"MethodDefinition"}, directly.\cr
Class \code{"function"}, from data part.\cr
Class \code{"PossibleMethod"}, by class \code{"MethodDefinition"}.\cr
Class \code{"OptionalMethods"}, by class \code{"MethodDefinition"}.
}
\section{Methods}{
\describe{
\item{findNextMethod}{\code{signature(method = "MethodWithNext")}:
used internally by method dispatch. }
\item{loadMethod}{\code{signature(method = "MethodWithNext")}: used
internally by method dispatch. }
\item{show}{\code{signature(object = "MethodWithNext")} }
}
}
\seealso{ \code{\link{callNextMethod}}, and
class \code{\linkS4class{MethodDefinition}}.
}
\keyword{classes}
| 1,933 |
gpl-2.0
|
868babfdad9a780d0304120b1656ffe1127f0403
|
limeng12/r-source
|
src/library/methods/man/MethodWithNext-class.Rd
|
% File src/library/methods/man/MethodWithNext-class.Rd
% Part of the R package, http://www.R-project.org
% Copyright 1995-2007 R Core Team
% Distributed under GPL 2 or later
\name{MethodWithNext-class}
\docType{class}
\alias{MethodWithNext-class}
\title{Class MethodWithNext }
\description{ Class of method definitions set up for callNextMethod }
\section{Objects from the Class}{
Objects from this class are generated as a side-effect of calls to
\code{\link{callNextMethod}}.
}
\section{Slots}{
\describe{
\item{\code{.Data}:}{Object of class \code{"function"}; the actual
function definition.}
\item{\code{nextMethod}:}{Object of class \code{"PossibleMethod"}
the method to use in response to a \code{\link{callNextMethod}()}
call.}
\item{\code{excluded}:}{Object of class \code{"list"}; one or more
signatures excluded in finding the next method. }
\item{\code{target}:}{Object of class \code{"signature"}, from class
\code{"MethodDefinition"}}
\item{\code{defined}:}{Object of class \code{"signature"}, from
class \code{"MethodDefinition"}}
\item{\code{generic}:}{Object of class \code{"character"}; the function
for which the method was created. }
}
}
\section{Extends}{
Class \code{"MethodDefinition"}, directly.\cr
Class \code{"function"}, from data part.\cr
Class \code{"PossibleMethod"}, by class \code{"MethodDefinition"}.\cr
Class \code{"OptionalMethods"}, by class \code{"MethodDefinition"}.
}
\section{Methods}{
\describe{
\item{findNextMethod}{\code{signature(method = "MethodWithNext")}:
used internally by method dispatch. }
\item{loadMethod}{\code{signature(method = "MethodWithNext")}: used
internally by method dispatch. }
\item{show}{\code{signature(object = "MethodWithNext")} }
}
}
\seealso{ \code{\link{callNextMethod}}, and
class \code{\linkS4class{MethodDefinition}}.
}
\keyword{classes}
| 1,933 |
gpl-2.0
|
6aeb5efb60c707a80aece087f9b207509929809a
|
ammaciel/lucC
|
man/lucC_toJSON.Rd
|
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/lucC_load_data.R
\docType{data}
\name{lucC_toJSON}
\alias{lucC_toJSON}
\title{Save result as JSON format}
\usage{
lucC_toJSON (data_tb, path_json_file = NULL)
}
\arguments{
\item{data_tb}{Tibble. A data frame with input values}
\item{path_json_file}{Character. Name path and file to save JSON file data}
}
\value{
JSON format to file stored
}
\description{
Save the output data in JSON format in an user's directory
}
\examples{
\dontrun{
library(lucC)
lucC_starting_point()
file_csv = "./data/example_TWDTW.csv"
input_tb_csv <- file_csv \%>\%
lucC_fromCSV(separator = ",", header_file = TRUE) #\%>\%
input_tb_csv
# save the input as json format
output_file = "~/Desktop/example_json.json"
lucC_toJSON(input_tb_csv, output_file)
}
}
\author{
Adeline M. Maciel
}
\keyword{datasets}
| 871 |
gpl-2.0
|
d5334aaf114a2dff9127614e8647e87e27ff4d84
|
carleshf/postRexposome
|
man/enrichDIS.Rd
|
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/01_AllMethods.R
\name{enrichDIS}
\alias{enrichDIS}
\title{Function to enrich results from differential studies on DisGeNET database}
\usage{
enrichDIS(object, rid = 1, fData.tag = 1, sel.pval = c("P.Value",
"adj.P.Val"), th.pval = 0.01, sel.feature = "genes", feature.null = "",
database = c("CTD_human", "UNIPROT", "CLINVAR", "GWASCAT", "ORPHANET",
"CURATED", "RGD", "MGD", "CTD_rat", "CTD_mouse", "PREDICTED", "ALL"),
verbose = FALSE, warnings = TRUE)
}
\arguments{
\item{object}{Object of class \code{ResultSet}.}
\item{rid}{(default \code{1}) If given \code{ResultSet} hat has more than
one result, id to select the result where the enrichment will be performed.}
\item{fData.tag}{(default \code{1}) Identifier of the annotation to be
used to mach the probes of \code{ResultSet} with gene identifier. In other
words, index of the element in \code{fData} that matches the omic dataset
to be used in the enrichment.}
\item{sel.pval}{(default \code{"adj.P.Val"}) Name of the P.Value columns to
filter datset's probes given \code{th.pval}.}
\item{th.pval}{(default \code{0.01}) Threshold used to include a probe (CpG)
into the enrichment analysis.}
\item{sel.feature}{(default \code{"genes"}) Name containing gene identifier
in \code{ResultSet}'s \code{fData}.}
\item{feature.null}{(default \code{""}) String identifier for non
gene-assigned probes.}
\item{database}{(default \code{"CURATED"}) Name of the version of the
DisGeNET's databse where the query will be computed. Check
\code{?disgenetGene} for a description of each name.}
\item{verbose}{(default \code{FALSE}) If set to \code{TRUE} messages
indicating the steps done by the method are raised.}
\item{warnings}{(default \code{TRUE}) If set to \code{FALSE} important
notes raised by the method are hide.}
}
\description{
This method takes the results from a \code{ResultSet} and uses the genes
associated to the probes to perform a query in DisGeNET and obtain the
diseases associated to the given genes.
}
\note{
Piñero J, Queralt-Rosinach N, Bravo A, Deu-Pons J, Bauer-Mehren A, Baron M,
Sanz F, Furlong LI;
DisGeNET: a discovery platform for the dynamical exploration of human
diseases and their genes.; Database (2015).
Queralt-Rosinach N, Piñero J, Bravo A, Sanz F, Furlong LI;
DisGeNET-RDF: harnessing the innovative power of the Semantic Web to explore
the genetic basis of diseases Bioinformatics; Bioinformatics (2016).
}
| 2,497 |
mit
|
868babfdad9a780d0304120b1656ffe1127f0403
|
glycerine/bigbird
|
r-3.0.2/src/library/methods/man/MethodWithNext-class.Rd
|
% File src/library/methods/man/MethodWithNext-class.Rd
% Part of the R package, http://www.R-project.org
% Copyright 1995-2007 R Core Team
% Distributed under GPL 2 or later
\name{MethodWithNext-class}
\docType{class}
\alias{MethodWithNext-class}
\title{Class MethodWithNext }
\description{ Class of method definitions set up for callNextMethod }
\section{Objects from the Class}{
Objects from this class are generated as a side-effect of calls to
\code{\link{callNextMethod}}.
}
\section{Slots}{
\describe{
\item{\code{.Data}:}{Object of class \code{"function"}; the actual
function definition.}
\item{\code{nextMethod}:}{Object of class \code{"PossibleMethod"}
the method to use in response to a \code{\link{callNextMethod}()}
call.}
\item{\code{excluded}:}{Object of class \code{"list"}; one or more
signatures excluded in finding the next method. }
\item{\code{target}:}{Object of class \code{"signature"}, from class
\code{"MethodDefinition"}}
\item{\code{defined}:}{Object of class \code{"signature"}, from
class \code{"MethodDefinition"}}
\item{\code{generic}:}{Object of class \code{"character"}; the function
for which the method was created. }
}
}
\section{Extends}{
Class \code{"MethodDefinition"}, directly.\cr
Class \code{"function"}, from data part.\cr
Class \code{"PossibleMethod"}, by class \code{"MethodDefinition"}.\cr
Class \code{"OptionalMethods"}, by class \code{"MethodDefinition"}.
}
\section{Methods}{
\describe{
\item{findNextMethod}{\code{signature(method = "MethodWithNext")}:
used internally by method dispatch. }
\item{loadMethod}{\code{signature(method = "MethodWithNext")}: used
internally by method dispatch. }
\item{show}{\code{signature(object = "MethodWithNext")} }
}
}
\seealso{ \code{\link{callNextMethod}}, and
class \code{\linkS4class{MethodDefinition}}.
}
\keyword{classes}
| 1,933 |
bsd-2-clause
|
868babfdad9a780d0304120b1656ffe1127f0403
|
hadley/r-source
|
src/library/methods/man/MethodWithNext-class.Rd
|
% File src/library/methods/man/MethodWithNext-class.Rd
% Part of the R package, http://www.R-project.org
% Copyright 1995-2007 R Core Team
% Distributed under GPL 2 or later
\name{MethodWithNext-class}
\docType{class}
\alias{MethodWithNext-class}
\title{Class MethodWithNext }
\description{ Class of method definitions set up for callNextMethod }
\section{Objects from the Class}{
Objects from this class are generated as a side-effect of calls to
\code{\link{callNextMethod}}.
}
\section{Slots}{
\describe{
\item{\code{.Data}:}{Object of class \code{"function"}; the actual
function definition.}
\item{\code{nextMethod}:}{Object of class \code{"PossibleMethod"}
the method to use in response to a \code{\link{callNextMethod}()}
call.}
\item{\code{excluded}:}{Object of class \code{"list"}; one or more
signatures excluded in finding the next method. }
\item{\code{target}:}{Object of class \code{"signature"}, from class
\code{"MethodDefinition"}}
\item{\code{defined}:}{Object of class \code{"signature"}, from
class \code{"MethodDefinition"}}
\item{\code{generic}:}{Object of class \code{"character"}; the function
for which the method was created. }
}
}
\section{Extends}{
Class \code{"MethodDefinition"}, directly.\cr
Class \code{"function"}, from data part.\cr
Class \code{"PossibleMethod"}, by class \code{"MethodDefinition"}.\cr
Class \code{"OptionalMethods"}, by class \code{"MethodDefinition"}.
}
\section{Methods}{
\describe{
\item{findNextMethod}{\code{signature(method = "MethodWithNext")}:
used internally by method dispatch. }
\item{loadMethod}{\code{signature(method = "MethodWithNext")}: used
internally by method dispatch. }
\item{show}{\code{signature(object = "MethodWithNext")} }
}
}
\seealso{ \code{\link{callNextMethod}}, and
class \code{\linkS4class{MethodDefinition}}.
}
\keyword{classes}
| 1,933 |
gpl-2.0
|
868babfdad9a780d0304120b1656ffe1127f0403
|
kalibera/rexp
|
src/library/methods/man/MethodWithNext-class.Rd
|
% File src/library/methods/man/MethodWithNext-class.Rd
% Part of the R package, http://www.R-project.org
% Copyright 1995-2007 R Core Team
% Distributed under GPL 2 or later
\name{MethodWithNext-class}
\docType{class}
\alias{MethodWithNext-class}
\title{Class MethodWithNext }
\description{ Class of method definitions set up for callNextMethod }
\section{Objects from the Class}{
Objects from this class are generated as a side-effect of calls to
\code{\link{callNextMethod}}.
}
\section{Slots}{
\describe{
\item{\code{.Data}:}{Object of class \code{"function"}; the actual
function definition.}
\item{\code{nextMethod}:}{Object of class \code{"PossibleMethod"}
the method to use in response to a \code{\link{callNextMethod}()}
call.}
\item{\code{excluded}:}{Object of class \code{"list"}; one or more
signatures excluded in finding the next method. }
\item{\code{target}:}{Object of class \code{"signature"}, from class
\code{"MethodDefinition"}}
\item{\code{defined}:}{Object of class \code{"signature"}, from
class \code{"MethodDefinition"}}
\item{\code{generic}:}{Object of class \code{"character"}; the function
for which the method was created. }
}
}
\section{Extends}{
Class \code{"MethodDefinition"}, directly.\cr
Class \code{"function"}, from data part.\cr
Class \code{"PossibleMethod"}, by class \code{"MethodDefinition"}.\cr
Class \code{"OptionalMethods"}, by class \code{"MethodDefinition"}.
}
\section{Methods}{
\describe{
\item{findNextMethod}{\code{signature(method = "MethodWithNext")}:
used internally by method dispatch. }
\item{loadMethod}{\code{signature(method = "MethodWithNext")}: used
internally by method dispatch. }
\item{show}{\code{signature(object = "MethodWithNext")} }
}
}
\seealso{ \code{\link{callNextMethod}}, and
class \code{\linkS4class{MethodDefinition}}.
}
\keyword{classes}
| 1,933 |
gpl-2.0
|
9afc0e1abef31bc9b6442825745675c4bcb5f1ce
|
ManonMartin/SOAP-NMR
|
man/Normalization.Rd
|
\name{Normalization}
\alias{Normalization}
\title{
Normalizes the spectra
}
\description{
Spectra normalization to correct for the dilution factor common to all biofuid samples.
}
\usage{
Normalization(Spectrum_data, type.norm, fromto.norm = c(3.05, 4.05), ref.norm = "median",
returnFactor = FALSE, verbose = FALSE)
}
\arguments{
\item{Spectrum_data}{Matrix containing the spectra in ppm, one row per spectrum.}
\item{type.norm}{Different types of normalization are available: \code{"mean"}, \code{"pqn"}, \code{"median"}, \code{"firstquartile"} or \code{"peak"}. No default value is provided. See the details section for more info.}
\item{fromto.norm}{Used if \code{type.norm} is \code{"peak"}. See details.}
\item{ref.norm}{The reference spectrum if \code{type.norm} is \code{"pqn"}. See details.}
\item{returnFactor}{If \code{TRUE}, returns a vector with the normalization factors.}
\item{verbose}{If \code{"TRUE"}, will print processing information.}
}
\details{
Normalization of spectra before their warping or their statistical analysis is necessary in order to be able to efficiently compare their relative peak intensities.
It is therefore appropriate to call this filter at the end of the preprocessing workflow.
Normalization types can be:
\describe{
\item{\code{mean}}{Each spectrum is divided by its mean so that its mean becomes 1.}
\item{\code{median}}{Each spectrum is divided by its median so that its median becomes 1.}
\item{\code{firstquartile}}{Each spectrum is divided by its first quartile so that its first quartile becomes 1.}
\item{\code{peak}}{Each spectrum is divided by the value of the peak of the spectrum contained between \code{"fromto.norm"} inclusive (\emph{i.e.} the maximum value of spectral intensities in that interval).}
\item{\code{pqn}}{Probabilistic Quotient Normalization from Dieterle et al. (2006). If \code{ref.norm} is \code{"median"} or \code{"mean"}, will use the median or the mean spectrum as the reference spectrum ; if it is a single number, will use the spectrum located at that row in the spectral matrix; if \code{ref.norm} is a numeric vertor of length equal to the number of spectral variables, it defines manually the reference spectrum.}
}
The choice of a proper normalisation method is a crucial although not straightforward step in a metabolomic analysis.
Applying CSN is accurate in the following situations:
\itemize{
\item when working on human/animal sera in the case of not serious pathology, given the homeostasis principle and since no dilution effect is present.
\item When working on biopsies, the “metabolome quantity” is set constant across the samples by adding a varying volume of a buffer and the same applies when working with cell media, where the quantity of cells is made constant.
}
To counteract all the dilution effects and the excretion differences between urine samples, the PQN approach is often recommended in the literature (Dieterle et al., 2006).
For any other situation (large difference between the groups, other kind of sample, etc.), the choice of the normalisation method is not straightforward. A solution is to refer to endogenous stable metabolites that are present in a constant quantity across samples and use them as standards to normalize all spectral profiles. For the urine samples, the creatinine has been considered as such standard (this option is also implemented in PepsNMR), even though it has been shown that the creatinine concentration could fluctuate given specific parameters (Tang et al., 2015). A review on normalization techniques for mass spectroscopy metabolomics from Wu \& Li (2015) provides some guidance in the choice on the normalization approach regarding the type of sample analysed and can be transposed to the NMR spectra normalisation.
}
\value{
\item{Spectrum_data}{The matrix of normalized spectra.}
}
\references{
Martin, M., Legat, B., Leenders, J., Vanwinsberghe, J., Rousseau, R., Boulanger, B., & Govaerts, B. (2018). PepsNMR for 1H NMR metabolomic data pre-processing. \emph{Analytica chimica acta}, 1019, 1-13.
Yiman Wu, Liang Li. (2016). \emph{Sample normalization methods in quantitative metabolomics}, Journal of Chromatography A, Volume 1430, Pages 80-95, ISSN 0021-9673
Tang KWA, Toh QC, Teo BW. (2015). \emph{Normalisation of urinary biomarkers to creatinine for clinical practice and research – when and why.} Singapore Medical Journal. 56(1):7-10.
Rousseau, R. (2011). \emph{Statistical contribution to the analysis of metabonomics data in 1H NMR spectroscopy}
(Doctoral dissertation, PhD thesis. Institut de statistique, biostatistique et sciences actuarielles, Université catholique de Louvain, Belgium).
Dieterle, F., Ross, A. , Schlotterbeck, G.,and Senn, H (2006). Probabilistic Quotient Normalization as Robust Method to Account for Dilution of Complex Biological Mixtures. \emph{Analytical Chemistry} 78 (13), 4281-4290
}
\author{
Benoît Legat & Manon Martin
}
\examples{
require(PepsNMRData)
Norm.spec <- Normalization(Data_HS_sp$Spectrum_data_HS_12,
type.norm = "mean")
}
\keyword{ manip }
| 5,161 |
gpl-2.0
|
868babfdad9a780d0304120b1656ffe1127f0403
|
patperry/r-source
|
src/library/methods/man/MethodWithNext-class.Rd
|
% File src/library/methods/man/MethodWithNext-class.Rd
% Part of the R package, http://www.R-project.org
% Copyright 1995-2007 R Core Team
% Distributed under GPL 2 or later
\name{MethodWithNext-class}
\docType{class}
\alias{MethodWithNext-class}
\title{Class MethodWithNext }
\description{ Class of method definitions set up for callNextMethod }
\section{Objects from the Class}{
Objects from this class are generated as a side-effect of calls to
\code{\link{callNextMethod}}.
}
\section{Slots}{
\describe{
\item{\code{.Data}:}{Object of class \code{"function"}; the actual
function definition.}
\item{\code{nextMethod}:}{Object of class \code{"PossibleMethod"}
the method to use in response to a \code{\link{callNextMethod}()}
call.}
\item{\code{excluded}:}{Object of class \code{"list"}; one or more
signatures excluded in finding the next method. }
\item{\code{target}:}{Object of class \code{"signature"}, from class
\code{"MethodDefinition"}}
\item{\code{defined}:}{Object of class \code{"signature"}, from
class \code{"MethodDefinition"}}
\item{\code{generic}:}{Object of class \code{"character"}; the function
for which the method was created. }
}
}
\section{Extends}{
Class \code{"MethodDefinition"}, directly.\cr
Class \code{"function"}, from data part.\cr
Class \code{"PossibleMethod"}, by class \code{"MethodDefinition"}.\cr
Class \code{"OptionalMethods"}, by class \code{"MethodDefinition"}.
}
\section{Methods}{
\describe{
\item{findNextMethod}{\code{signature(method = "MethodWithNext")}:
used internally by method dispatch. }
\item{loadMethod}{\code{signature(method = "MethodWithNext")}: used
internally by method dispatch. }
\item{show}{\code{signature(object = "MethodWithNext")} }
}
}
\seealso{ \code{\link{callNextMethod}}, and
class \code{\linkS4class{MethodDefinition}}.
}
\keyword{classes}
| 1,933 |
gpl-2.0
|
868babfdad9a780d0304120b1656ffe1127f0403
|
hxfeng/R-3.1.2
|
src/library/methods/man/MethodWithNext-class.Rd
|
% File src/library/methods/man/MethodWithNext-class.Rd
% Part of the R package, http://www.R-project.org
% Copyright 1995-2007 R Core Team
% Distributed under GPL 2 or later
\name{MethodWithNext-class}
\docType{class}
\alias{MethodWithNext-class}
\title{Class MethodWithNext }
\description{ Class of method definitions set up for callNextMethod }
\section{Objects from the Class}{
Objects from this class are generated as a side-effect of calls to
\code{\link{callNextMethod}}.
}
\section{Slots}{
\describe{
\item{\code{.Data}:}{Object of class \code{"function"}; the actual
function definition.}
\item{\code{nextMethod}:}{Object of class \code{"PossibleMethod"}
the method to use in response to a \code{\link{callNextMethod}()}
call.}
\item{\code{excluded}:}{Object of class \code{"list"}; one or more
signatures excluded in finding the next method. }
\item{\code{target}:}{Object of class \code{"signature"}, from class
\code{"MethodDefinition"}}
\item{\code{defined}:}{Object of class \code{"signature"}, from
class \code{"MethodDefinition"}}
\item{\code{generic}:}{Object of class \code{"character"}; the function
for which the method was created. }
}
}
\section{Extends}{
Class \code{"MethodDefinition"}, directly.\cr
Class \code{"function"}, from data part.\cr
Class \code{"PossibleMethod"}, by class \code{"MethodDefinition"}.\cr
Class \code{"OptionalMethods"}, by class \code{"MethodDefinition"}.
}
\section{Methods}{
\describe{
\item{findNextMethod}{\code{signature(method = "MethodWithNext")}:
used internally by method dispatch. }
\item{loadMethod}{\code{signature(method = "MethodWithNext")}: used
internally by method dispatch. }
\item{show}{\code{signature(object = "MethodWithNext")} }
}
}
\seealso{ \code{\link{callNextMethod}}, and
class \code{\linkS4class{MethodDefinition}}.
}
\keyword{classes}
| 1,933 |
gpl-2.0
|
868babfdad9a780d0304120b1656ffe1127f0403
|
cxxr-devel/cxxr-svn-mirror
|
src/library/methods/man/MethodWithNext-class.Rd
|
% File src/library/methods/man/MethodWithNext-class.Rd
% Part of the R package, http://www.R-project.org
% Copyright 1995-2007 R Core Team
% Distributed under GPL 2 or later
\name{MethodWithNext-class}
\docType{class}
\alias{MethodWithNext-class}
\title{Class MethodWithNext }
\description{ Class of method definitions set up for callNextMethod }
\section{Objects from the Class}{
Objects from this class are generated as a side-effect of calls to
\code{\link{callNextMethod}}.
}
\section{Slots}{
\describe{
\item{\code{.Data}:}{Object of class \code{"function"}; the actual
function definition.}
\item{\code{nextMethod}:}{Object of class \code{"PossibleMethod"}
the method to use in response to a \code{\link{callNextMethod}()}
call.}
\item{\code{excluded}:}{Object of class \code{"list"}; one or more
signatures excluded in finding the next method. }
\item{\code{target}:}{Object of class \code{"signature"}, from class
\code{"MethodDefinition"}}
\item{\code{defined}:}{Object of class \code{"signature"}, from
class \code{"MethodDefinition"}}
\item{\code{generic}:}{Object of class \code{"character"}; the function
for which the method was created. }
}
}
\section{Extends}{
Class \code{"MethodDefinition"}, directly.\cr
Class \code{"function"}, from data part.\cr
Class \code{"PossibleMethod"}, by class \code{"MethodDefinition"}.\cr
Class \code{"OptionalMethods"}, by class \code{"MethodDefinition"}.
}
\section{Methods}{
\describe{
\item{findNextMethod}{\code{signature(method = "MethodWithNext")}:
used internally by method dispatch. }
\item{loadMethod}{\code{signature(method = "MethodWithNext")}: used
internally by method dispatch. }
\item{show}{\code{signature(object = "MethodWithNext")} }
}
}
\seealso{ \code{\link{callNextMethod}}, and
class \code{\linkS4class{MethodDefinition}}.
}
\keyword{classes}
| 1,933 |
gpl-2.0
|
868babfdad9a780d0304120b1656ffe1127f0403
|
jagdeesh109/RRO
|
R-src/src/library/methods/man/MethodWithNext-class.Rd
|
% File src/library/methods/man/MethodWithNext-class.Rd
% Part of the R package, http://www.R-project.org
% Copyright 1995-2007 R Core Team
% Distributed under GPL 2 or later
\name{MethodWithNext-class}
\docType{class}
\alias{MethodWithNext-class}
\title{Class MethodWithNext }
\description{ Class of method definitions set up for callNextMethod }
\section{Objects from the Class}{
Objects from this class are generated as a side-effect of calls to
\code{\link{callNextMethod}}.
}
\section{Slots}{
\describe{
\item{\code{.Data}:}{Object of class \code{"function"}; the actual
function definition.}
\item{\code{nextMethod}:}{Object of class \code{"PossibleMethod"}
the method to use in response to a \code{\link{callNextMethod}()}
call.}
\item{\code{excluded}:}{Object of class \code{"list"}; one or more
signatures excluded in finding the next method. }
\item{\code{target}:}{Object of class \code{"signature"}, from class
\code{"MethodDefinition"}}
\item{\code{defined}:}{Object of class \code{"signature"}, from
class \code{"MethodDefinition"}}
\item{\code{generic}:}{Object of class \code{"character"}; the function
for which the method was created. }
}
}
\section{Extends}{
Class \code{"MethodDefinition"}, directly.\cr
Class \code{"function"}, from data part.\cr
Class \code{"PossibleMethod"}, by class \code{"MethodDefinition"}.\cr
Class \code{"OptionalMethods"}, by class \code{"MethodDefinition"}.
}
\section{Methods}{
\describe{
\item{findNextMethod}{\code{signature(method = "MethodWithNext")}:
used internally by method dispatch. }
\item{loadMethod}{\code{signature(method = "MethodWithNext")}: used
internally by method dispatch. }
\item{show}{\code{signature(object = "MethodWithNext")} }
}
}
\seealso{ \code{\link{callNextMethod}}, and
class \code{\linkS4class{MethodDefinition}}.
}
\keyword{classes}
| 1,933 |
gpl-2.0
|
868babfdad9a780d0304120b1656ffe1127f0403
|
cmosetick/RRO
|
R-src/src/library/methods/man/MethodWithNext-class.Rd
|
% File src/library/methods/man/MethodWithNext-class.Rd
% Part of the R package, http://www.R-project.org
% Copyright 1995-2007 R Core Team
% Distributed under GPL 2 or later
\name{MethodWithNext-class}
\docType{class}
\alias{MethodWithNext-class}
\title{Class MethodWithNext }
\description{ Class of method definitions set up for callNextMethod }
\section{Objects from the Class}{
Objects from this class are generated as a side-effect of calls to
\code{\link{callNextMethod}}.
}
\section{Slots}{
\describe{
\item{\code{.Data}:}{Object of class \code{"function"}; the actual
function definition.}
\item{\code{nextMethod}:}{Object of class \code{"PossibleMethod"}
the method to use in response to a \code{\link{callNextMethod}()}
call.}
\item{\code{excluded}:}{Object of class \code{"list"}; one or more
signatures excluded in finding the next method. }
\item{\code{target}:}{Object of class \code{"signature"}, from class
\code{"MethodDefinition"}}
\item{\code{defined}:}{Object of class \code{"signature"}, from
class \code{"MethodDefinition"}}
\item{\code{generic}:}{Object of class \code{"character"}; the function
for which the method was created. }
}
}
\section{Extends}{
Class \code{"MethodDefinition"}, directly.\cr
Class \code{"function"}, from data part.\cr
Class \code{"PossibleMethod"}, by class \code{"MethodDefinition"}.\cr
Class \code{"OptionalMethods"}, by class \code{"MethodDefinition"}.
}
\section{Methods}{
\describe{
\item{findNextMethod}{\code{signature(method = "MethodWithNext")}:
used internally by method dispatch. }
\item{loadMethod}{\code{signature(method = "MethodWithNext")}: used
internally by method dispatch. }
\item{show}{\code{signature(object = "MethodWithNext")} }
}
}
\seealso{ \code{\link{callNextMethod}}, and
class \code{\linkS4class{MethodDefinition}}.
}
\keyword{classes}
| 1,933 |
gpl-2.0
|
868babfdad9a780d0304120b1656ffe1127f0403
|
lajus/customr
|
src/library/methods/man/MethodWithNext-class.Rd
|
% File src/library/methods/man/MethodWithNext-class.Rd
% Part of the R package, http://www.R-project.org
% Copyright 1995-2007 R Core Team
% Distributed under GPL 2 or later
\name{MethodWithNext-class}
\docType{class}
\alias{MethodWithNext-class}
\title{Class MethodWithNext }
\description{ Class of method definitions set up for callNextMethod }
\section{Objects from the Class}{
Objects from this class are generated as a side-effect of calls to
\code{\link{callNextMethod}}.
}
\section{Slots}{
\describe{
\item{\code{.Data}:}{Object of class \code{"function"}; the actual
function definition.}
\item{\code{nextMethod}:}{Object of class \code{"PossibleMethod"}
the method to use in response to a \code{\link{callNextMethod}()}
call.}
\item{\code{excluded}:}{Object of class \code{"list"}; one or more
signatures excluded in finding the next method. }
\item{\code{target}:}{Object of class \code{"signature"}, from class
\code{"MethodDefinition"}}
\item{\code{defined}:}{Object of class \code{"signature"}, from
class \code{"MethodDefinition"}}
\item{\code{generic}:}{Object of class \code{"character"}; the function
for which the method was created. }
}
}
\section{Extends}{
Class \code{"MethodDefinition"}, directly.\cr
Class \code{"function"}, from data part.\cr
Class \code{"PossibleMethod"}, by class \code{"MethodDefinition"}.\cr
Class \code{"OptionalMethods"}, by class \code{"MethodDefinition"}.
}
\section{Methods}{
\describe{
\item{findNextMethod}{\code{signature(method = "MethodWithNext")}:
used internally by method dispatch. }
\item{loadMethod}{\code{signature(method = "MethodWithNext")}: used
internally by method dispatch. }
\item{show}{\code{signature(object = "MethodWithNext")} }
}
}
\seealso{ \code{\link{callNextMethod}}, and
class \code{\linkS4class{MethodDefinition}}.
}
\keyword{classes}
| 1,933 |
gpl-2.0
|
868babfdad9a780d0304120b1656ffe1127f0403
|
jeffreyhorner/R-Array-Hash
|
src/library/methods/man/MethodWithNext-class.Rd
|
% File src/library/methods/man/MethodWithNext-class.Rd
% Part of the R package, http://www.R-project.org
% Copyright 1995-2007 R Core Team
% Distributed under GPL 2 or later
\name{MethodWithNext-class}
\docType{class}
\alias{MethodWithNext-class}
\title{Class MethodWithNext }
\description{ Class of method definitions set up for callNextMethod }
\section{Objects from the Class}{
Objects from this class are generated as a side-effect of calls to
\code{\link{callNextMethod}}.
}
\section{Slots}{
\describe{
\item{\code{.Data}:}{Object of class \code{"function"}; the actual
function definition.}
\item{\code{nextMethod}:}{Object of class \code{"PossibleMethod"}
the method to use in response to a \code{\link{callNextMethod}()}
call.}
\item{\code{excluded}:}{Object of class \code{"list"}; one or more
signatures excluded in finding the next method. }
\item{\code{target}:}{Object of class \code{"signature"}, from class
\code{"MethodDefinition"}}
\item{\code{defined}:}{Object of class \code{"signature"}, from
class \code{"MethodDefinition"}}
\item{\code{generic}:}{Object of class \code{"character"}; the function
for which the method was created. }
}
}
\section{Extends}{
Class \code{"MethodDefinition"}, directly.\cr
Class \code{"function"}, from data part.\cr
Class \code{"PossibleMethod"}, by class \code{"MethodDefinition"}.\cr
Class \code{"OptionalMethods"}, by class \code{"MethodDefinition"}.
}
\section{Methods}{
\describe{
\item{findNextMethod}{\code{signature(method = "MethodWithNext")}:
used internally by method dispatch. }
\item{loadMethod}{\code{signature(method = "MethodWithNext")}: used
internally by method dispatch. }
\item{show}{\code{signature(object = "MethodWithNext")} }
}
}
\seealso{ \code{\link{callNextMethod}}, and
class \code{\linkS4class{MethodDefinition}}.
}
\keyword{classes}
| 1,933 |
gpl-2.0
|
868babfdad9a780d0304120b1656ffe1127f0403
|
ChiWang/r-source
|
src/library/methods/man/MethodWithNext-class.Rd
|
% File src/library/methods/man/MethodWithNext-class.Rd
% Part of the R package, http://www.R-project.org
% Copyright 1995-2007 R Core Team
% Distributed under GPL 2 or later
\name{MethodWithNext-class}
\docType{class}
\alias{MethodWithNext-class}
\title{Class MethodWithNext }
\description{ Class of method definitions set up for callNextMethod }
\section{Objects from the Class}{
Objects from this class are generated as a side-effect of calls to
\code{\link{callNextMethod}}.
}
\section{Slots}{
\describe{
\item{\code{.Data}:}{Object of class \code{"function"}; the actual
function definition.}
\item{\code{nextMethod}:}{Object of class \code{"PossibleMethod"}
the method to use in response to a \code{\link{callNextMethod}()}
call.}
\item{\code{excluded}:}{Object of class \code{"list"}; one or more
signatures excluded in finding the next method. }
\item{\code{target}:}{Object of class \code{"signature"}, from class
\code{"MethodDefinition"}}
\item{\code{defined}:}{Object of class \code{"signature"}, from
class \code{"MethodDefinition"}}
\item{\code{generic}:}{Object of class \code{"character"}; the function
for which the method was created. }
}
}
\section{Extends}{
Class \code{"MethodDefinition"}, directly.\cr
Class \code{"function"}, from data part.\cr
Class \code{"PossibleMethod"}, by class \code{"MethodDefinition"}.\cr
Class \code{"OptionalMethods"}, by class \code{"MethodDefinition"}.
}
\section{Methods}{
\describe{
\item{findNextMethod}{\code{signature(method = "MethodWithNext")}:
used internally by method dispatch. }
\item{loadMethod}{\code{signature(method = "MethodWithNext")}: used
internally by method dispatch. }
\item{show}{\code{signature(object = "MethodWithNext")} }
}
}
\seealso{ \code{\link{callNextMethod}}, and
class \code{\linkS4class{MethodDefinition}}.
}
\keyword{classes}
| 1,933 |
gpl-2.0
|
868babfdad9a780d0304120b1656ffe1127f0403
|
skyguy94/R
|
src/library/methods/man/MethodWithNext-class.Rd
|
% File src/library/methods/man/MethodWithNext-class.Rd
% Part of the R package, http://www.R-project.org
% Copyright 1995-2007 R Core Team
% Distributed under GPL 2 or later
\name{MethodWithNext-class}
\docType{class}
\alias{MethodWithNext-class}
\title{Class MethodWithNext }
\description{ Class of method definitions set up for callNextMethod }
\section{Objects from the Class}{
Objects from this class are generated as a side-effect of calls to
\code{\link{callNextMethod}}.
}
\section{Slots}{
\describe{
\item{\code{.Data}:}{Object of class \code{"function"}; the actual
function definition.}
\item{\code{nextMethod}:}{Object of class \code{"PossibleMethod"}
the method to use in response to a \code{\link{callNextMethod}()}
call.}
\item{\code{excluded}:}{Object of class \code{"list"}; one or more
signatures excluded in finding the next method. }
\item{\code{target}:}{Object of class \code{"signature"}, from class
\code{"MethodDefinition"}}
\item{\code{defined}:}{Object of class \code{"signature"}, from
class \code{"MethodDefinition"}}
\item{\code{generic}:}{Object of class \code{"character"}; the function
for which the method was created. }
}
}
\section{Extends}{
Class \code{"MethodDefinition"}, directly.\cr
Class \code{"function"}, from data part.\cr
Class \code{"PossibleMethod"}, by class \code{"MethodDefinition"}.\cr
Class \code{"OptionalMethods"}, by class \code{"MethodDefinition"}.
}
\section{Methods}{
\describe{
\item{findNextMethod}{\code{signature(method = "MethodWithNext")}:
used internally by method dispatch. }
\item{loadMethod}{\code{signature(method = "MethodWithNext")}: used
internally by method dispatch. }
\item{show}{\code{signature(object = "MethodWithNext")} }
}
}
\seealso{ \code{\link{callNextMethod}}, and
class \code{\linkS4class{MethodDefinition}}.
}
\keyword{classes}
| 1,933 |
gpl-2.0
|
5d27319315bb5ec76c3f26daadc90f5a379a9e9f
|
jeffreyhorner/R-Judy-Arrays
|
src/library/base/man/RdUtils.Rd
|
% File src/library/base/man/RdUtils.Rd
% Part of the R package, http://www.R-project.org
% Copyright 1995-2014 R Core Team
% Distributed under GPL 2 or later
\name{RdUtils}
\alias{Rdconv}
\alias{Rd2pdf}
\alias{RD2PDF_INPUTENC}
\title{Utilities for Processing Rd Files}
\description{
Utilities for converting files in R documentation (Rd) format to other
formats or create indices from them, and for converting documentation
in other formats to Rd format.
}
\usage{
\special{R CMD Rdconv [options] file}
\special{R CMD Rd2pdf [options] files}
}
\arguments{
\item{file}{the path to a file to be processed.}
\item{files}{a list of file names specifying the R documentation
sources to use, by either giving the paths to the files, or the path
to a directory with the sources of a package.}
\item{options}{further options to control the processing, or for
obtaining information about usage and version of the utility.}
}
\details{
\command{R CMD Rdconv} converts Rd format to plain text, HTML or LaTeX
formats: it can also extract the examples.
\command{R CMD Rd2pdf} is the user-level program for producing PDF output
from Rd sources. It will make use of the environment variables
#ifdef unix
\env{R_PAPERSIZE} (set by \command{R CMD}, with a default set when \R
was installed: values for \env{R_PAPERSIZE} are \code{a4},
\code{letter}, \code{legal} and \code{executive})
#endif
#ifdef windows
\env{R_PAPERSIZE} (default \code{a4}, also \code{legal} and
\code{executive})
#endif
and \env{R_PDFVIEWER} (the PDF previewer). Also,
\env{RD2PDF_INPUTENC} can be set to \code{inputenx} to make use of the
LaTeX package of that name rather than \code{inputenc}: this might be
needed for better support of the UTF-8 encoding.
Use \command{R CMD \var{foo} --help} to obtain usage information on utility
\code{\var{foo}}.
}
\seealso{
The chapter \dQuote{Processing Rd format} in the \dQuote{Writing \R
Extensions} manual.
}
\keyword{utilities}
| 1,996 |
gpl-2.0
|
5d27319315bb5ec76c3f26daadc90f5a379a9e9f
|
ChiWang/r-source
|
src/library/base/man/RdUtils.Rd
|
% File src/library/base/man/RdUtils.Rd
% Part of the R package, http://www.R-project.org
% Copyright 1995-2014 R Core Team
% Distributed under GPL 2 or later
\name{RdUtils}
\alias{Rdconv}
\alias{Rd2pdf}
\alias{RD2PDF_INPUTENC}
\title{Utilities for Processing Rd Files}
\description{
Utilities for converting files in R documentation (Rd) format to other
formats or create indices from them, and for converting documentation
in other formats to Rd format.
}
\usage{
\special{R CMD Rdconv [options] file}
\special{R CMD Rd2pdf [options] files}
}
\arguments{
\item{file}{the path to a file to be processed.}
\item{files}{a list of file names specifying the R documentation
sources to use, by either giving the paths to the files, or the path
to a directory with the sources of a package.}
\item{options}{further options to control the processing, or for
obtaining information about usage and version of the utility.}
}
\details{
\command{R CMD Rdconv} converts Rd format to plain text, HTML or LaTeX
formats: it can also extract the examples.
\command{R CMD Rd2pdf} is the user-level program for producing PDF output
from Rd sources. It will make use of the environment variables
#ifdef unix
\env{R_PAPERSIZE} (set by \command{R CMD}, with a default set when \R
was installed: values for \env{R_PAPERSIZE} are \code{a4},
\code{letter}, \code{legal} and \code{executive})
#endif
#ifdef windows
\env{R_PAPERSIZE} (default \code{a4}, also \code{legal} and
\code{executive})
#endif
and \env{R_PDFVIEWER} (the PDF previewer). Also,
\env{RD2PDF_INPUTENC} can be set to \code{inputenx} to make use of the
LaTeX package of that name rather than \code{inputenc}: this might be
needed for better support of the UTF-8 encoding.
Use \command{R CMD \var{foo} --help} to obtain usage information on utility
\code{\var{foo}}.
}
\seealso{
The chapter \dQuote{Processing Rd format} in the \dQuote{Writing \R
Extensions} manual.
}
\keyword{utilities}
| 1,996 |
gpl-2.0
|
5d27319315bb5ec76c3f26daadc90f5a379a9e9f
|
jagdeesh109/RRO
|
R-src/src/library/base/man/RdUtils.Rd
|
% File src/library/base/man/RdUtils.Rd
% Part of the R package, http://www.R-project.org
% Copyright 1995-2014 R Core Team
% Distributed under GPL 2 or later
\name{RdUtils}
\alias{Rdconv}
\alias{Rd2pdf}
\alias{RD2PDF_INPUTENC}
\title{Utilities for Processing Rd Files}
\description{
Utilities for converting files in R documentation (Rd) format to other
formats or create indices from them, and for converting documentation
in other formats to Rd format.
}
\usage{
\special{R CMD Rdconv [options] file}
\special{R CMD Rd2pdf [options] files}
}
\arguments{
\item{file}{the path to a file to be processed.}
\item{files}{a list of file names specifying the R documentation
sources to use, by either giving the paths to the files, or the path
to a directory with the sources of a package.}
\item{options}{further options to control the processing, or for
obtaining information about usage and version of the utility.}
}
\details{
\command{R CMD Rdconv} converts Rd format to plain text, HTML or LaTeX
formats: it can also extract the examples.
\command{R CMD Rd2pdf} is the user-level program for producing PDF output
from Rd sources. It will make use of the environment variables
#ifdef unix
\env{R_PAPERSIZE} (set by \command{R CMD}, with a default set when \R
was installed: values for \env{R_PAPERSIZE} are \code{a4},
\code{letter}, \code{legal} and \code{executive})
#endif
#ifdef windows
\env{R_PAPERSIZE} (default \code{a4}, also \code{legal} and
\code{executive})
#endif
and \env{R_PDFVIEWER} (the PDF previewer). Also,
\env{RD2PDF_INPUTENC} can be set to \code{inputenx} to make use of the
LaTeX package of that name rather than \code{inputenc}: this might be
needed for better support of the UTF-8 encoding.
Use \command{R CMD \var{foo} --help} to obtain usage information on utility
\code{\var{foo}}.
}
\seealso{
The chapter \dQuote{Processing Rd format} in the \dQuote{Writing \R
Extensions} manual.
}
\keyword{utilities}
| 1,996 |
gpl-2.0
|
5d27319315bb5ec76c3f26daadc90f5a379a9e9f
|
hadley/r-source
|
src/library/base/man/RdUtils.Rd
|
% File src/library/base/man/RdUtils.Rd
% Part of the R package, http://www.R-project.org
% Copyright 1995-2014 R Core Team
% Distributed under GPL 2 or later
\name{RdUtils}
\alias{Rdconv}
\alias{Rd2pdf}
\alias{RD2PDF_INPUTENC}
\title{Utilities for Processing Rd Files}
\description{
Utilities for converting files in R documentation (Rd) format to other
formats or create indices from them, and for converting documentation
in other formats to Rd format.
}
\usage{
\special{R CMD Rdconv [options] file}
\special{R CMD Rd2pdf [options] files}
}
\arguments{
\item{file}{the path to a file to be processed.}
\item{files}{a list of file names specifying the R documentation
sources to use, by either giving the paths to the files, or the path
to a directory with the sources of a package.}
\item{options}{further options to control the processing, or for
obtaining information about usage and version of the utility.}
}
\details{
\command{R CMD Rdconv} converts Rd format to plain text, HTML or LaTeX
formats: it can also extract the examples.
\command{R CMD Rd2pdf} is the user-level program for producing PDF output
from Rd sources. It will make use of the environment variables
#ifdef unix
\env{R_PAPERSIZE} (set by \command{R CMD}, with a default set when \R
was installed: values for \env{R_PAPERSIZE} are \code{a4},
\code{letter}, \code{legal} and \code{executive})
#endif
#ifdef windows
\env{R_PAPERSIZE} (default \code{a4}, also \code{legal} and
\code{executive})
#endif
and \env{R_PDFVIEWER} (the PDF previewer). Also,
\env{RD2PDF_INPUTENC} can be set to \code{inputenx} to make use of the
LaTeX package of that name rather than \code{inputenc}: this might be
needed for better support of the UTF-8 encoding.
Use \command{R CMD \var{foo} --help} to obtain usage information on utility
\code{\var{foo}}.
}
\seealso{
The chapter \dQuote{Processing Rd format} in the \dQuote{Writing \R
Extensions} manual.
}
\keyword{utilities}
| 1,996 |
gpl-2.0
|
5d27319315bb5ec76c3f26daadc90f5a379a9e9f
|
jeffreyhorner/R-Array-Hash
|
src/library/base/man/RdUtils.Rd
|
% File src/library/base/man/RdUtils.Rd
% Part of the R package, http://www.R-project.org
% Copyright 1995-2014 R Core Team
% Distributed under GPL 2 or later
\name{RdUtils}
\alias{Rdconv}
\alias{Rd2pdf}
\alias{RD2PDF_INPUTENC}
\title{Utilities for Processing Rd Files}
\description{
Utilities for converting files in R documentation (Rd) format to other
formats or create indices from them, and for converting documentation
in other formats to Rd format.
}
\usage{
\special{R CMD Rdconv [options] file}
\special{R CMD Rd2pdf [options] files}
}
\arguments{
\item{file}{the path to a file to be processed.}
\item{files}{a list of file names specifying the R documentation
sources to use, by either giving the paths to the files, or the path
to a directory with the sources of a package.}
\item{options}{further options to control the processing, or for
obtaining information about usage and version of the utility.}
}
\details{
\command{R CMD Rdconv} converts Rd format to plain text, HTML or LaTeX
formats: it can also extract the examples.
\command{R CMD Rd2pdf} is the user-level program for producing PDF output
from Rd sources. It will make use of the environment variables
#ifdef unix
\env{R_PAPERSIZE} (set by \command{R CMD}, with a default set when \R
was installed: values for \env{R_PAPERSIZE} are \code{a4},
\code{letter}, \code{legal} and \code{executive})
#endif
#ifdef windows
\env{R_PAPERSIZE} (default \code{a4}, also \code{legal} and
\code{executive})
#endif
and \env{R_PDFVIEWER} (the PDF previewer). Also,
\env{RD2PDF_INPUTENC} can be set to \code{inputenx} to make use of the
LaTeX package of that name rather than \code{inputenc}: this might be
needed for better support of the UTF-8 encoding.
Use \command{R CMD \var{foo} --help} to obtain usage information on utility
\code{\var{foo}}.
}
\seealso{
The chapter \dQuote{Processing Rd format} in the \dQuote{Writing \R
Extensions} manual.
}
\keyword{utilities}
| 1,996 |
gpl-2.0
|
2247e02338492aed5f402459f8043e80f631184f
|
ekenah/transtat
|
man/pval.transph.Rd
|
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/transph.R
\name{pval.transph}
\alias{pval.transph}
\title{p-values for estimated coefficients}
\usage{
\method{pval}{transph}(creg, parm, type = "wald")
}
\arguments{
\item{parm}{A coefficient name or vector of coefficient names. If missing,
p-values are calculated for all estimated parameters.}
\item{type}{The type of p-value. Options are \code{wald} for Wald p-values
and \code{lr} for likelihood ratio p-values. Likelihood ratio p-values are
available only when who-infected-whom is completely observed.}
\item{treg}{An object of class \code{transph}.}
}
\value{
A named vector of p-values.
}
\description{
Calculates p-values for coefficient estimates from a \code{transph} model
using a normal approximation or a likelihood ratio chi-squared statistic.
}
\author{
Eben Kenah \email{kenah.1@osu.edu}
}
| 892 |
lgpl-3.0
|
1fe46c23be692f60c28b5e9befcc0bd7a1b3eabb
|
rstudio/sparklyr
|
man/ml_clustering_evaluator.Rd
|
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/ml_evaluation_clustering.R
\name{ml_clustering_evaluator}
\alias{ml_clustering_evaluator}
\title{Spark ML - Clustering Evaluator}
\usage{
ml_clustering_evaluator(
x,
features_col = "features",
prediction_col = "prediction",
metric_name = "silhouette",
uid = random_string("clustering_evaluator_"),
...
)
}
\arguments{
\item{x}{A \code{spark_connection} object or a \code{tbl_spark} containing label and prediction columns. The latter should be the output of \code{\link{sdf_predict}}.}
\item{features_col}{Name of features column.}
\item{prediction_col}{Name of the prediction column.}
\item{metric_name}{The performance metric. Currently supports "silhouette".}
\item{uid}{A character string used to uniquely identify the ML estimator.}
\item{...}{Optional arguments; currently unused.}
}
\value{
The calculated performance metric
}
\description{
Evaluator for clustering results. The metric computes the Silhouette measure using the squared
Euclidean distance. The Silhouette is a measure for the validation of the consistency
within clusters. It ranges between 1 and -1, where a value close to 1 means that the
points in a cluster are close to the other points in the same cluster and far from the
points of the other clusters.
}
\examples{
\dontrun{
sc <- spark_connect(master = "local")
iris_tbl <- sdf_copy_to(sc, iris, name = "iris_tbl", overwrite = TRUE)
partitions <- iris_tbl \%>\%
sdf_random_split(training = 0.7, test = 0.3, seed = 1111)
iris_training <- partitions$training
iris_test <- partitions$test
formula <- Species ~ .
# Train the models
kmeans_model <- ml_kmeans(iris_training, formula = formula)
b_kmeans_model <- ml_bisecting_kmeans(iris_training, formula = formula)
gmm_model <- ml_gaussian_mixture(iris_training, formula = formula)
# Predict
pred_kmeans <- ml_predict(kmeans_model, iris_test)
pred_b_kmeans <- ml_predict(b_kmeans_model, iris_test)
pred_gmm <- ml_predict(gmm_model, iris_test)
# Evaluate
ml_clustering_evaluator(pred_kmeans)
ml_clustering_evaluator(pred_b_kmeans)
ml_clustering_evaluator(pred_gmm)
}
}
| 2,159 |
apache-2.0
|
5d27319315bb5ec76c3f26daadc90f5a379a9e9f
|
o-/Rexperiments
|
src/library/base/man/RdUtils.Rd
|
% File src/library/base/man/RdUtils.Rd
% Part of the R package, http://www.R-project.org
% Copyright 1995-2014 R Core Team
% Distributed under GPL 2 or later
\name{RdUtils}
\alias{Rdconv}
\alias{Rd2pdf}
\alias{RD2PDF_INPUTENC}
\title{Utilities for Processing Rd Files}
\description{
Utilities for converting files in R documentation (Rd) format to other
formats or create indices from them, and for converting documentation
in other formats to Rd format.
}
\usage{
\special{R CMD Rdconv [options] file}
\special{R CMD Rd2pdf [options] files}
}
\arguments{
\item{file}{the path to a file to be processed.}
\item{files}{a list of file names specifying the R documentation
sources to use, by either giving the paths to the files, or the path
to a directory with the sources of a package.}
\item{options}{further options to control the processing, or for
obtaining information about usage and version of the utility.}
}
\details{
\command{R CMD Rdconv} converts Rd format to plain text, HTML or LaTeX
formats: it can also extract the examples.
\command{R CMD Rd2pdf} is the user-level program for producing PDF output
from Rd sources. It will make use of the environment variables
#ifdef unix
\env{R_PAPERSIZE} (set by \command{R CMD}, with a default set when \R
was installed: values for \env{R_PAPERSIZE} are \code{a4},
\code{letter}, \code{legal} and \code{executive})
#endif
#ifdef windows
\env{R_PAPERSIZE} (default \code{a4}, also \code{legal} and
\code{executive})
#endif
and \env{R_PDFVIEWER} (the PDF previewer). Also,
\env{RD2PDF_INPUTENC} can be set to \code{inputenx} to make use of the
LaTeX package of that name rather than \code{inputenc}: this might be
needed for better support of the UTF-8 encoding.
Use \command{R CMD \var{foo} --help} to obtain usage information on utility
\code{\var{foo}}.
}
\seealso{
The chapter \dQuote{Processing Rd format} in the \dQuote{Writing \R
Extensions} manual.
}
\keyword{utilities}
| 1,996 |
gpl-2.0
|
1d7aa1b33bf5ca964d2afc81a895665d47f0e485
|
cscheid/rgithub
|
man/get.repository.tags.Rd
|
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/repositories.R
\name{get.repository.tags}
\alias{get.repository.tags}
\title{get list of repository tags}
\usage{
get.repository.tags(owner, repo, ctx = get.github.context())
}
\arguments{
\item{owner}{the repo owner (user, org, etc)}
\item{repo}{the name of the repo}
\item{ctx}{the github context object}
}
\value{
list of tags
}
\description{
get list of repository tags
}
| 457 |
mit
|
1d7aa1b33bf5ca964d2afc81a895665d47f0e485
|
s-u/rgithub
|
man/get.repository.tags.Rd
|
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/repositories.R
\name{get.repository.tags}
\alias{get.repository.tags}
\title{get list of repository tags}
\usage{
get.repository.tags(owner, repo, ctx = get.github.context())
}
\arguments{
\item{owner}{the repo owner (user, org, etc)}
\item{repo}{the name of the repo}
\item{ctx}{the github context object}
}
\value{
list of tags
}
\description{
get list of repository tags
}
| 457 |
mit
|
5d27319315bb5ec76c3f26daadc90f5a379a9e9f
|
limeng12/r-source
|
src/library/base/man/RdUtils.Rd
|
% File src/library/base/man/RdUtils.Rd
% Part of the R package, http://www.R-project.org
% Copyright 1995-2014 R Core Team
% Distributed under GPL 2 or later
\name{RdUtils}
\alias{Rdconv}
\alias{Rd2pdf}
\alias{RD2PDF_INPUTENC}
\title{Utilities for Processing Rd Files}
\description{
Utilities for converting files in R documentation (Rd) format to other
formats or create indices from them, and for converting documentation
in other formats to Rd format.
}
\usage{
\special{R CMD Rdconv [options] file}
\special{R CMD Rd2pdf [options] files}
}
\arguments{
\item{file}{the path to a file to be processed.}
\item{files}{a list of file names specifying the R documentation
sources to use, by either giving the paths to the files, or the path
to a directory with the sources of a package.}
\item{options}{further options to control the processing, or for
obtaining information about usage and version of the utility.}
}
\details{
\command{R CMD Rdconv} converts Rd format to plain text, HTML or LaTeX
formats: it can also extract the examples.
\command{R CMD Rd2pdf} is the user-level program for producing PDF output
from Rd sources. It will make use of the environment variables
#ifdef unix
\env{R_PAPERSIZE} (set by \command{R CMD}, with a default set when \R
was installed: values for \env{R_PAPERSIZE} are \code{a4},
\code{letter}, \code{legal} and \code{executive})
#endif
#ifdef windows
\env{R_PAPERSIZE} (default \code{a4}, also \code{legal} and
\code{executive})
#endif
and \env{R_PDFVIEWER} (the PDF previewer). Also,
\env{RD2PDF_INPUTENC} can be set to \code{inputenx} to make use of the
LaTeX package of that name rather than \code{inputenc}: this might be
needed for better support of the UTF-8 encoding.
Use \command{R CMD \var{foo} --help} to obtain usage information on utility
\code{\var{foo}}.
}
\seealso{
The chapter \dQuote{Processing Rd format} in the \dQuote{Writing \R
Extensions} manual.
}
\keyword{utilities}
| 1,996 |
gpl-2.0
|
f5cf84067f574511cd8bf53511369c689dbd6ec2
|
Shians/Glimma
|
man/glimma.Rd
|
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/package.R
\docType{package}
\name{glimma}
\alias{glimma}
\title{Glimma: interactive graphics from limma}
\description{
The Glimma package provides iteractive versions of plots frequently used in
the limma package. Currently the MDS and MD plots have been implemented. The
functions can be used with both limma, edgeR and DESeq objecs.
}
\section{Main functions}{
\code{\link{glMDSPlot}},
\code{\link{glMDPlot}},
\code{\link{glXYPlot}}
}
| 517 |
lgpl-3.0
|
5d27319315bb5ec76c3f26daadc90f5a379a9e9f
|
patperry/r-source
|
src/library/base/man/RdUtils.Rd
|
% File src/library/base/man/RdUtils.Rd
% Part of the R package, http://www.R-project.org
% Copyright 1995-2014 R Core Team
% Distributed under GPL 2 or later
\name{RdUtils}
\alias{Rdconv}
\alias{Rd2pdf}
\alias{RD2PDF_INPUTENC}
\title{Utilities for Processing Rd Files}
\description{
Utilities for converting files in R documentation (Rd) format to other
formats or create indices from them, and for converting documentation
in other formats to Rd format.
}
\usage{
\special{R CMD Rdconv [options] file}
\special{R CMD Rd2pdf [options] files}
}
\arguments{
\item{file}{the path to a file to be processed.}
\item{files}{a list of file names specifying the R documentation
sources to use, by either giving the paths to the files, or the path
to a directory with the sources of a package.}
\item{options}{further options to control the processing, or for
obtaining information about usage and version of the utility.}
}
\details{
\command{R CMD Rdconv} converts Rd format to plain text, HTML or LaTeX
formats: it can also extract the examples.
\command{R CMD Rd2pdf} is the user-level program for producing PDF output
from Rd sources. It will make use of the environment variables
#ifdef unix
\env{R_PAPERSIZE} (set by \command{R CMD}, with a default set when \R
was installed: values for \env{R_PAPERSIZE} are \code{a4},
\code{letter}, \code{legal} and \code{executive})
#endif
#ifdef windows
\env{R_PAPERSIZE} (default \code{a4}, also \code{legal} and
\code{executive})
#endif
and \env{R_PDFVIEWER} (the PDF previewer). Also,
\env{RD2PDF_INPUTENC} can be set to \code{inputenx} to make use of the
LaTeX package of that name rather than \code{inputenc}: this might be
needed for better support of the UTF-8 encoding.
Use \command{R CMD \var{foo} --help} to obtain usage information on utility
\code{\var{foo}}.
}
\seealso{
The chapter \dQuote{Processing Rd format} in the \dQuote{Writing \R
Extensions} manual.
}
\keyword{utilities}
| 1,996 |
gpl-2.0
|
8a03e08907f0883495f7a4987245a4119351e1d4
|
agoldst/dfrtopics
|
man/align_topics.Rd
|
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/align.R
\name{align_topics}
\alias{align_topics}
\alias{print.topic_alignment}
\title{Align topics across models}
\usage{
align_topics(dst, threshold)
print.topic_alignment(x)
}
\arguments{
\item{dst}{result from \code{\link{model_distances}} (q.v.)}
\item{threshold}{maximum dissimilarity allowed between merging clusters. By
default, the threshold is set so that any two topics from different models
may ultimately join a cluster. More aggressive thresholding is
recommended, in order to expose isolated topics.}
}
\value{
a \code{topic_alignment} object, which is a list of:
\describe{
\item{\code{clusters}}{list of vectors, one for each model, giving cluster
numbers of the topics in the model}
\item{\code{distances}}{list of vectors, one for each model, giving the
distance at which the given topic merged into its cluster. Because
single-link clustering (if I've even implemented it correctly) is
subject to "chaining," this is not necessarily an indication of the
quality of a cluster, but it may give some hints.}
\item{\code{model_distances}}{The supplied \code{model_distances}}
\item{\code{threshold}}{The threshold used}
}
To explore the result, \code{\link{alignment_frame}} may be useful.
}
\description{
Given information about the dissimilarities among topics across
a set of models, this function attempts to identify groups of
similar topics from each model. In particular, it greedily seeks
the single-link clustering in which no two topics from the same
model are found in the same cluster ("up-to-one mapping"). The idea
is from (Chuang et al., 2015). The implementation is my own (slow,
unverified, \emph{experimental}) one. To prepare topic dissimilarities to
supply to this function, use \code{\link{model_distances}}.
}
\examples{
\dontrun{
# assume m1, m2, m3 are models
dists <- model_distances(list(m1, m2, m3), n_words=40)
clusters <- align_topics(dists, threshold=0.5)
# data frame readout
alignment_frame(clusters)
}
}
\references{
Chuang, J, et al. 2015. "TopicCheck: Interactive
Alignment for Assessing Topic Model Stability." NAACL HLT.
\url{http://scholar.princeton.edu/bstewart/publications/topiccheck-interactive-alignment-assessing-topic-model-stability}.
}
\seealso{
\code{\link{model_distances}}, \code{\link{alignment_frame}}
}
| 2,381 |
mit
|
5d27319315bb5ec76c3f26daadc90f5a379a9e9f
|
cmosetick/RRO
|
R-src/src/library/base/man/RdUtils.Rd
|
% File src/library/base/man/RdUtils.Rd
% Part of the R package, http://www.R-project.org
% Copyright 1995-2014 R Core Team
% Distributed under GPL 2 or later
\name{RdUtils}
\alias{Rdconv}
\alias{Rd2pdf}
\alias{RD2PDF_INPUTENC}
\title{Utilities for Processing Rd Files}
\description{
Utilities for converting files in R documentation (Rd) format to other
formats or create indices from them, and for converting documentation
in other formats to Rd format.
}
\usage{
\special{R CMD Rdconv [options] file}
\special{R CMD Rd2pdf [options] files}
}
\arguments{
\item{file}{the path to a file to be processed.}
\item{files}{a list of file names specifying the R documentation
sources to use, by either giving the paths to the files, or the path
to a directory with the sources of a package.}
\item{options}{further options to control the processing, or for
obtaining information about usage and version of the utility.}
}
\details{
\command{R CMD Rdconv} converts Rd format to plain text, HTML or LaTeX
formats: it can also extract the examples.
\command{R CMD Rd2pdf} is the user-level program for producing PDF output
from Rd sources. It will make use of the environment variables
#ifdef unix
\env{R_PAPERSIZE} (set by \command{R CMD}, with a default set when \R
was installed: values for \env{R_PAPERSIZE} are \code{a4},
\code{letter}, \code{legal} and \code{executive})
#endif
#ifdef windows
\env{R_PAPERSIZE} (default \code{a4}, also \code{legal} and
\code{executive})
#endif
and \env{R_PDFVIEWER} (the PDF previewer). Also,
\env{RD2PDF_INPUTENC} can be set to \code{inputenx} to make use of the
LaTeX package of that name rather than \code{inputenc}: this might be
needed for better support of the UTF-8 encoding.
Use \command{R CMD \var{foo} --help} to obtain usage information on utility
\code{\var{foo}}.
}
\seealso{
The chapter \dQuote{Processing Rd format} in the \dQuote{Writing \R
Extensions} manual.
}
\keyword{utilities}
| 1,996 |
gpl-2.0
|
030e6c7a94fa006e9e22b1ae55539d604aba9cd1
|
ErickChacon/day2day
|
man/mean_na.Rd
|
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/na-handle.R
\name{mean_na}
\alias{mean_na}
\title{Sum vector with NA values.}
\usage{
mean_na(x, ...)
}
\arguments{
\item{x}{vector}
\item{...}{Parameters passed to \code{mean}}
}
\description{
\code{mean_na} Mean vector with NA values.
}
\details{
details.
}
\author{
Erick A. Chacon-Montalvan
}
| 376 |
gpl-3.0
|
83e4af255137aebfed6b740e268341c92d10dc03
|
dpattermann-usgs/repgen
|
man/doAddToPlot.Rd
|
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/correctionsataglance-render.R
\name{doAddToPlot}
\alias{doAddToPlot}
\title{Do add to plot}
\usage{
doAddToPlot(data)
}
\arguments{
\item{data}{The lane data to check}
}
\description{
Returns whether or not the provided lane data should be added to the plot
}
| 338 |
cc0-1.0
|
b24f75855f2da9f4cb0cd54fd9b0c731e4519751
|
ErickChacon/day2day
|
man/ggscale_seq.Rd
|
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/gg-adds.R
\name{ggscale_seq}
\alias{ggscale_seq}
\title{Creates sequence for continuous scale .}
\usage{
ggscale_seq(by = 1)
}
\arguments{
\item{by}{desired step of the sequence as in \code{\link{seq}}.}
}
\value{
a function that can be provided to \code{\link{scale_x_continuous}}
or similar ones.
}
\description{
\code{ggscale_seq} Creates a function that can be provide to compute
break for a continuous scale axis.
}
\details{
details.
}
\examples{
x <- rnorm(100)
ggscale_seq(0.5)(x)
ggscale_seq(1)(x)
}
\author{
Erick A. Chacon-Montalvan
}
| 626 |
gpl-3.0
|
94db8925ba5c4e429f986e576289b3b5f7659f83
|
jbrzusto/motus-R-package
|
man/ensureParamOverridesTable.Rd
|
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/ensureParamOverridesTable.R
\name{ensureParamOverridesTable}
\alias{ensureParamOverridesTable}
\title{make sure we have a valid parameterOverrides table}
\usage{
ensureParamOverridesTable()
}
\value{
returns a \code{safeSQL} object to the override database
}
\description{
The function takes no parameters.
}
\details{
This table allows us to specify overrides to default parameters for the tag finder.
Ideally, these would be specified on the motus side, by receiver deployment,
but for now we do it like this. For example, some projects operate on a listening
frequency of 150.1 MHz. We need to specify that default frequency to the tag
finder in case the relevant frequency-setting records from the SG did not
make it into the data stream (usually because the user didn't send files with
pre-GPS dates like 2000-01-01).
Each override can apply to either a particular receiver deployment, or to all
receiver deployments for a project.
If the serno field is not null, the override is for a receiver deployment, given
by serno and either the timestamp range (tsStart, tsEnd) for Lotek receivers, or
the boot session range (monoBNlow, monoBNhigh) for SGs. A range where the
second element (tsEnd or monoBNhigh) is null is treated as on-going.
If the serno field is null but the projectID is not null, then the override applies
to all receivers for the specified project. For SGs, only those boot sessions
where the receiver's deployment belonged to that project apply.
FIXME: for Lotek receivers, the parameter overrides apply for the entire
sequence of data processed for this receiver.
}
\author{
John Brzustowski \email{jbrzusto@REMOVE_THIS_PART_fastmail.fm}
}
| 1,749 |
gpl-2.0
|
83e4af255137aebfed6b740e268341c92d10dc03
|
USGS-R/repgen
|
man/doAddToPlot.Rd
|
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/correctionsataglance-render.R
\name{doAddToPlot}
\alias{doAddToPlot}
\title{Do add to plot}
\usage{
doAddToPlot(data)
}
\arguments{
\item{data}{The lane data to check}
}
\description{
Returns whether or not the provided lane data should be added to the plot
}
| 338 |
cc0-1.0
|
83e4af255137aebfed6b740e268341c92d10dc03
|
zmoore-usgs/repgen
|
man/doAddToPlot.Rd
|
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/correctionsataglance-render.R
\name{doAddToPlot}
\alias{doAddToPlot}
\title{Do add to plot}
\usage{
doAddToPlot(data)
}
\arguments{
\item{data}{The lane data to check}
}
\description{
Returns whether or not the provided lane data should be added to the plot
}
| 338 |
cc0-1.0
|
83e4af255137aebfed6b740e268341c92d10dc03
|
lindsaycarr/repgen
|
man/doAddToPlot.Rd
|
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/correctionsataglance-render.R
\name{doAddToPlot}
\alias{doAddToPlot}
\title{Do add to plot}
\usage{
doAddToPlot(data)
}
\arguments{
\item{data}{The lane data to check}
}
\description{
Returns whether or not the provided lane data should be added to the plot
}
| 338 |
cc0-1.0
|
83e4af255137aebfed6b740e268341c92d10dc03
|
mhines-usgs/repgen
|
man/doAddToPlot.Rd
|
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/correctionsataglance-render.R
\name{doAddToPlot}
\alias{doAddToPlot}
\title{Do add to plot}
\usage{
doAddToPlot(data)
}
\arguments{
\item{data}{The lane data to check}
}
\description{
Returns whether or not the provided lane data should be added to the plot
}
| 338 |
cc0-1.0
|
83e4af255137aebfed6b740e268341c92d10dc03
|
thongsav-usgs/repgen
|
man/doAddToPlot.Rd
|
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/correctionsataglance-render.R
\name{doAddToPlot}
\alias{doAddToPlot}
\title{Do add to plot}
\usage{
doAddToPlot(data)
}
\arguments{
\item{data}{The lane data to check}
}
\description{
Returns whether or not the provided lane data should be added to the plot
}
| 338 |
cc0-1.0
|
94db8925ba5c4e429f986e576289b3b5f7659f83
|
jbrzusto/motusServer
|
man/ensureParamOverridesTable.Rd
|
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/ensureParamOverridesTable.R
\name{ensureParamOverridesTable}
\alias{ensureParamOverridesTable}
\title{make sure we have a valid parameterOverrides table}
\usage{
ensureParamOverridesTable()
}
\value{
returns a \code{safeSQL} object to the override database
}
\description{
The function takes no parameters.
}
\details{
This table allows us to specify overrides to default parameters for the tag finder.
Ideally, these would be specified on the motus side, by receiver deployment,
but for now we do it like this. For example, some projects operate on a listening
frequency of 150.1 MHz. We need to specify that default frequency to the tag
finder in case the relevant frequency-setting records from the SG did not
make it into the data stream (usually because the user didn't send files with
pre-GPS dates like 2000-01-01).
Each override can apply to either a particular receiver deployment, or to all
receiver deployments for a project.
If the serno field is not null, the override is for a receiver deployment, given
by serno and either the timestamp range (tsStart, tsEnd) for Lotek receivers, or
the boot session range (monoBNlow, monoBNhigh) for SGs. A range where the
second element (tsEnd or monoBNhigh) is null is treated as on-going.
If the serno field is null but the projectID is not null, then the override applies
to all receivers for the specified project. For SGs, only those boot sessions
where the receiver's deployment belonged to that project apply.
FIXME: for Lotek receivers, the parameter overrides apply for the entire
sequence of data processed for this receiver.
}
\author{
John Brzustowski \email{jbrzusto@REMOVE_THIS_PART_fastmail.fm}
}
| 1,749 |
gpl-2.0
|
0c7c12c2c3655895affe71d8de43ad394eaab6d5
|
looker-open-source/lookr
|
man/DashboardAppearance.Rd
|
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/DashboardAppearance.r
\name{DashboardAppearance}
\alias{DashboardAppearance}
\title{DashboardAppearance Class}
\description{
DashboardAppearance Class
DashboardAppearance Class
}
\section{Public fields}{
\if{html}{\out{<div class="r6-fields">}}
\describe{
\item{\code{page_side_margins}}{}
\item{\code{page_background_color}}{}
\item{\code{tile_title_alignment}}{}
\item{\code{tile_space_between}}{}
\item{\code{tile_background_color}}{}
\item{\code{tile_shadow}}{}
\item{\code{key_color}}{}
}
\if{html}{\out{</div>}}
}
\section{Methods}{
\subsection{Public methods}{
\itemize{
\item \href{#method-new}{\code{DashboardAppearance$new()}}
\item \href{#method-toJSON}{\code{DashboardAppearance$toJSON()}}
\item \href{#method-fromJSONObject}{\code{DashboardAppearance$fromJSONObject()}}
\item \href{#method-fromJSON}{\code{DashboardAppearance$fromJSON()}}
\item \href{#method-toJSONString}{\code{DashboardAppearance$toJSONString()}}
\item \href{#method-fromJSONString}{\code{DashboardAppearance$fromJSONString()}}
\item \href{#method-clone}{\code{DashboardAppearance$clone()}}
}
}
\if{html}{\out{<hr>}}
\if{html}{\out{<a id="method-new"></a>}}
\if{latex}{\out{\hypertarget{method-new}{}}}
\subsection{Method \code{new()}}{
\subsection{Usage}{
\if{html}{\out{<div class="r">}}\preformatted{DashboardAppearance$new(
page_side_margins,
page_background_color,
tile_title_alignment,
tile_space_between,
tile_background_color,
tile_shadow,
key_color
)}\if{html}{\out{</div>}}
}
}
\if{html}{\out{<hr>}}
\if{html}{\out{<a id="method-toJSON"></a>}}
\if{latex}{\out{\hypertarget{method-toJSON}{}}}
\subsection{Method \code{toJSON()}}{
\subsection{Usage}{
\if{html}{\out{<div class="r">}}\preformatted{DashboardAppearance$toJSON()}\if{html}{\out{</div>}}
}
}
\if{html}{\out{<hr>}}
\if{html}{\out{<a id="method-fromJSONObject"></a>}}
\if{latex}{\out{\hypertarget{method-fromJSONObject}{}}}
\subsection{Method \code{fromJSONObject()}}{
\subsection{Usage}{
\if{html}{\out{<div class="r">}}\preformatted{DashboardAppearance$fromJSONObject(DashboardAppearanceJsonObject)}\if{html}{\out{</div>}}
}
}
\if{html}{\out{<hr>}}
\if{html}{\out{<a id="method-fromJSON"></a>}}
\if{latex}{\out{\hypertarget{method-fromJSON}{}}}
\subsection{Method \code{fromJSON()}}{
\subsection{Usage}{
\if{html}{\out{<div class="r">}}\preformatted{DashboardAppearance$fromJSON(DashboardAppearanceJson)}\if{html}{\out{</div>}}
}
}
\if{html}{\out{<hr>}}
\if{html}{\out{<a id="method-toJSONString"></a>}}
\if{latex}{\out{\hypertarget{method-toJSONString}{}}}
\subsection{Method \code{toJSONString()}}{
\subsection{Usage}{
\if{html}{\out{<div class="r">}}\preformatted{DashboardAppearance$toJSONString()}\if{html}{\out{</div>}}
}
}
\if{html}{\out{<hr>}}
\if{html}{\out{<a id="method-fromJSONString"></a>}}
\if{latex}{\out{\hypertarget{method-fromJSONString}{}}}
\subsection{Method \code{fromJSONString()}}{
\subsection{Usage}{
\if{html}{\out{<div class="r">}}\preformatted{DashboardAppearance$fromJSONString(DashboardAppearanceJson)}\if{html}{\out{</div>}}
}
}
\if{html}{\out{<hr>}}
\if{html}{\out{<a id="method-clone"></a>}}
\if{latex}{\out{\hypertarget{method-clone}{}}}
\subsection{Method \code{clone()}}{
The objects of this class are cloneable with this method.
\subsection{Usage}{
\if{html}{\out{<div class="r">}}\preformatted{DashboardAppearance$clone(deep = FALSE)}\if{html}{\out{</div>}}
}
\subsection{Arguments}{
\if{html}{\out{<div class="arguments">}}
\describe{
\item{\code{deep}}{Whether to make a deep clone.}
}
\if{html}{\out{</div>}}
}
}
}
| 3,613 |
mit
|
d043a7b1e3ec1785771213a5c4c1204eb28273f9
|
cxxr-devel/cxxr-svn-mirror
|
src/library/Recommended/mgcv/man/gam.check.Rd
|
\name{gam.check}
\alias{gam.check}
\title{Some diagnostics for a fitted gam model}
\description{ Takes a fitted \code{gam} object produced by \code{gam()} and produces some diagnostic information
about the fitting procedure and results. The default is to produce 4 residual
plots, some information about the convergence of the smoothness selection optimization, and to run
diagnostic tests of whether the basis dimension choises are adequate.
}
\usage{
gam.check(b, old.style=FALSE,
type=c("deviance","pearson","response"),
k.sample=5000,k.rep=200,
rep=0, level=.9, rl.col=2, rep.col="gray80", \dots)
}
\arguments{
\item{b}{a fitted \code{gam} object as produced by \code{\link{gam}()}.}
\item{old.style}{If you want old fashioned plots, exactly as in Wood, 2006, set to \code{TRUE}.}
\item{type}{type of residuals, see \code{\link{residuals.gam}}, used in
all plots.}
\item{k.sample}{Above this k testing uses a random sub-sample of data.}
\item{k.rep}{how many re-shuffles to do to get p-value for k testing.}
\item{rep, level, rl.col, rep.col}{
arguments passed to \code{\link{qq.gam}()} when \code{old.style} is
false, see there.}
\item{\dots}{extra graphics parameters to pass to plotting functions.}
}
\value{A vector of reference quantiles for the residual distribution, if these can be computed.}
\details{ Checking a fitted \code{gam} is like checking a fitted \code{glm}, with two main differences. Firstly,
the basis dimensions used for smooth terms need to be checked, to ensure that they are not so small that they force
oversmoothing: the defaults are arbitrary. \code{\link{choose.k}} provides more detail, but the diagnostic tests described below and reported by this function may also help. Secondly, fitting may not always be as robust to violation of the distributional assumptions as would be the case for a regular GLM, so slightly more care may be needed here. In particular, the thoery of quasi-likelihood implies that if the mean variance relationship is OK for a GLM, then other departures from the assumed distribution are not problematic: GAMs can sometimes be more sensitive. For example, un-modelled overdispersion will typically lead to overfit, as the smoothness selection criterion tries to reduce the scale parameter to the one specified. Similarly, it is not clear how sensitive REML and ML smoothness selection will be to deviations from the assumed response dsistribution. For these reasons this routine uses an enhanced residual QQ plot.
This function plots 4 standard diagnostic plots, some smoothing parameter estimation
convergence information and the results of tests which may indicate if the smoothing basis dimension
for a term is too low.
Usually the 4 plots are various residual plots. For the default optimization methods the convergence information is summarized in a readable way, but for other optimization methods, whatever is returned by way of
convergence diagnostics is simply printed.
The test of whether the basis dimension for a smooth is adequate is based on computing an estimate of the residual variance
based on differencing residuals that are near neighbours according to the (numeric) covariates of the smooth. This estimate divided by the residual variance is the \code{k-index} reported. The further below 1 this is, the more likely it is that there is missed pattern left in the residuals. The \code{p-value} is computed by simulation: the residuals are randomly re-shuffled \code{k.rep} times to obtain the null distribution of the differencing variance estimator, if there is no pattern in the residuals. For models fitted to more than \code{k.sample} data, the tests are based of \code{k.sample} randomly sampled data. Low p-values may indicate that the basis dimension, \code{k}, has been set too low, especially if the reported \code{edf} is close to \code{k\'}, the maximum possible EDF for the term. Note the disconcerting fact that if the test statistic itself is based on random resampling and the null is true, then the associated p-values will of course vary widely from one replicate to the next. Currently smooths of factor variables are not supported and will give an \code{NA} p-value.
Doubling a suspect \code{k} and re-fitting is sensible: if the reported \code{edf} increases substantially then you may have been missing something in the first fit. Of course p-values can be low for reasons other than a too low \code{k}. See \code{\link{choose.k}} for fuller discussion.
The QQ plot produced is usually created by a call to \code{\link{qq.gam}}, and plots deviance residuals
against approximate theoretical quantilies of the deviance residual distribution, according to the fitted model.
If this looks odd then investigate further using \code{\link{qq.gam}}. Note that residuals for models fitted to binary data contain very little
information useful for model checking (it is necessary to find some way of aggregating them first), so the QQ plot is unlikely
to be useful in this case.
}
\references{
N.H. Augustin, E-A Sauleaub, S.N. Wood (2012) On quantile quantile plots for generalized linear models.
Computational Statistics & Data Analysis. 56(8), 2404-3409.
Wood S.N. (2006) Generalized Additive Models: An Introduction with R. Chapman
and Hall/CRC Press.
\url{http://www.maths.bath.ac.uk/~sw283/}
}
\author{ Simon N. Wood \email{simon.wood@r-project.org}}
\seealso{ \code{\link{choose.k}}, \code{\link{gam}}, \code{\link{magic}}}
\examples{
library(mgcv)
set.seed(0)
dat <- gamSim(1,n=200)
b<-gam(y~s(x0)+s(x1)+s(x2)+s(x3),data=dat)
plot(b,pages=1)
gam.check(b,pch=19,cex=.3)
}
\keyword{models} \keyword{smooth} \keyword{regression}%-- one or more ...
| 5,741 |
gpl-2.0
|
63d0cb0c6d885871129fb61bffa9257883150b6c
|
limeng12/r-source
|
src/library/base/man/as.POSIXlt.Rd
|
% File src/library/base/man/as.POSIXlt.Rd
% Part of the R package, http://www.R-project.org
% Copyright 1995-2014 R Core Team
% Distributed under GPL 2 or later
\name{as.POSIX*}
\alias{as.POSIXct}
\alias{as.POSIXct.default}
\alias{as.POSIXct.POSIXlt}
\alias{as.POSIXct.date}
\alias{as.POSIXct.dates}
\alias{as.POSIXct.Date}
\alias{as.POSIXct.numeric}
\alias{as.POSIXlt}
\alias{as.POSIXlt.Date}
\alias{as.POSIXlt.date}
\alias{as.POSIXlt.dates}
\alias{as.POSIXlt.POSIXct}
\alias{as.POSIXlt.factor}
\alias{as.POSIXlt.character}
\alias{as.POSIXlt.default}
\alias{as.POSIXlt.numeric}
\alias{as.double.POSIXlt}
\title{Date-time Conversion Functions}
\description{
Functions to manipulate objects of classes \code{"POSIXlt"} and
\code{"POSIXct"} representing calendar dates and times.
}
\usage{
as.POSIXct(x, tz = "", \dots)
as.POSIXlt(x, tz = "", \dots)
\method{as.POSIXlt}{character}(x, tz = "", format, \dots)
\method{as.POSIXlt}{numeric}(x, tz = "", origin, \dots)
\method{as.double}{POSIXlt}(x, \dots)
}
\arguments{
\item{x}{An object to be converted.}
\item{tz}{A time zone specification to be used for the conversion,
\emph{if one is required}. System-specific (see \link{time zones}),
but \code{""} is the current time zone, and \code{"GMT"} is UTC
(Universal Time, Coordinated). Invalid values are most commonly
treated as UTC, on some platforms with a warning.}
\item{\dots}{further arguments to be passed to or from other methods.}
\item{format}{character string giving a date-time format as used
by \code{\link{strptime}}.}
\item{origin}{a date-time object, or something which can be coerced by
\code{as.POSIXct(tz = "GMT")} to such an object.}
}
\details{
The \code{as.POSIX*} functions convert an object to one of the two
classes used to represent date/times (calendar dates plus time to the
nearest second). They can convert a wide variety of objects,
including objects of the other class and of classes \code{"Date"},
\code{"date"} (from package \pkg{\link[date:as.date]{date}}),
\code{"chron"} and \code{"dates"} (from package
\pkg{\link[chron]{chron}}) to these classes. Dates without times are
treated as being at midnight UTC.
They can also convert character strings of the formats
\code{"2001-02-03"} and \code{"2001/02/03"} optionally followed by
white space and a time in the format \code{"14:52"} or
\code{"14:52:03"}. (Formats such as \code{"01/02/03"} are ambiguous
but can be converted via a format specification by
\code{\link{strptime}}.) Fractional seconds are allowed.
Alternatively, \code{format} can be specified for character vectors or
factors: if it is not specified and no standard format works for
all non-\code{NA} inputs an error is thrown.
If \code{format} is specified, remember that some of the format
specifications are locale-specific, and you may need to set the
\code{LC_TIME} category appropriately \emph{via}
\code{\link{Sys.setlocale}}. This most often affects the use of
\code{\%b}, \code{\%B} (month names) and \code{\%p} (AM/PM).
Logical \code{NA}s can be converted to either of the classes, but no
other logical vectors can be.
If you are given a numeric time as the number of seconds since an
epoch, see the examples.
Character input is first converted to class \code{"POSIXlt"} by
\code{\link{strptime}}: numeric input is first converted to
\code{"POSIXct"}. Any conversion that needs to go between the two
date-time classes requires a time zone: conversion from
\code{"POSIXlt"} to \code{"POSIXct"} will validate times in the
selected time zone. One issue is what happens at transitions
to and from DST, for example in the UK
\preformatted{as.POSIXct(strptime("2011-03-27 01:30:00", "\%Y-\%m-\%d \%H:\%M:\%S"))
as.POSIXct(strptime("2010-10-31 01:30:00", "\%Y-\%m-\%d \%H:\%M:\%S"))
}
are respectively invalid (the clocks went forward at 1:00 GMT to 2:00
BST) and ambiguous (the clocks went back at 2:00 BST to 1:00 GMT). What
happens in such cases is OS-specific: one should expect the first to
be \code{NA}, but the second could be interpreted as either BST or
GMT (and common OSes give both possible values). Note too (see
\code{\link{strftime}}) that OS facilities may not format invalid
times correctly.
}
\value{
\code{as.POSIXct} and \code{as.POSIXlt} return an object of the
appropriate class. If \code{tz} was specified, \code{as.POSIXlt}
will give an appropriate \code{"tzone"} attribute. Date-times known
to be invalid will be returned as \code{NA}.
}
\note{
Some of the concepts used have to be extended backwards in time (the
usage is said to be \sQuote{proleptic}). For example, the origin of
time for the \code{"POSIXct"} class, \sQuote{1970-01-01 00:00.00 UTC},
is before UTC was defined. More importantly, conversion is done
assuming the Gregorian calendar which was introduced in 1582 and not
used universally until the 20th century. One of the
re-interpretations assumed by ISO 8601:2004 is that there was a year
zero, even though current year numbering (and zero) is a much later
concept (525 AD for year numbers from 1 AD).
If you want to extract specific aspects of a time (such as the day of
the week) just convert it to class \code{"POSIXlt"} and extract the
relevant component(s) of the list, or if you want a character
representation (such as a named day of the week) use the
\code{\link[base:format.POSIXlt]{format}} method.
If a time zone is needed and that specified is invalid on your system,
what happens is system-specific but attempts to set it will probably
be ignored.
Conversion from character needs to find a suitable format unless one
is supplied (by trying common formats in turn): this can be slow for
long inputs.
}
\seealso{
\link{DateTimeClasses} for details of the classes;
\code{\link{strptime}} for conversion to and from character
representations.
\code{\link{Sys.timezone}} for details of the (system-specific) naming
of time zones.
\link{locales} for locale-specific aspects.
}
\examples{\donttest{
(z <- Sys.time()) # the current datetime, as class "POSIXct"
unclass(z) # a large integer
floor(unclass(z)/86400) # the number of days since 1970-01-01 (UTC)
(now <- as.POSIXlt(Sys.time())) # the current datetime, as class "POSIXlt"
unlist(unclass(now)) # a list shown as a named vector
now$year + 1900 # see ?DateTimeClasses
months(now); weekdays(now) # see ?months
## suppose we have a time in seconds since 1960-01-01 00:00:00 GMT
## (the origin used by SAS)
z <- 1472562988
# ways to convert this
as.POSIXct(z, origin = "1960-01-01") # local
as.POSIXct(z, origin = "1960-01-01", tz = "GMT") # in UTC
## SPSS dates (R-help 2006-02-16)
z <- c(10485849600, 10477641600, 10561104000, 10562745600)
as.Date(as.POSIXct(z, origin = "1582-10-14", tz = "GMT"))
## Stata date-times: milliseconds since 1960-01-01 00:00:00 GMT
## format %tc excludes leap-seconds, assumed here
## For format %tC including leap seconds, see foreign::read.dta()
z <- 1579598122120
op <- options(digits.secs = 3)
# avoid rounding down: milliseconds are not exactly representable
as.POSIXct((z+0.1)/1000, origin = "1960-01-01")
options(op)
## Matlab 'serial day number' (days and fractional days)
z <- 7.343736909722223e5 # 2010-08-23 16:35:00
as.POSIXct((z - 719529)*86400, origin = "1970-01-01", tz = "UTC")
as.POSIXlt(Sys.time(), "GMT") # the current time in UTC
}
\donttest{## These may not be correct names on your system
as.POSIXlt(Sys.time(), "America/New_York") # in New York
as.POSIXlt(Sys.time(), "EST5EDT") # alternative.
as.POSIXlt(Sys.time(), "EST" ) # somewhere in Eastern Canada
as.POSIXlt(Sys.time(), "HST") # in Hawaii
as.POSIXlt(Sys.time(), "Australia/Darwin")
}
#ifdef windows
cols <- c("code", "coordinates", "TZ", "comments")
tmp <- read.delim(file.path(R.home("share"), "zoneinfo", "zone.tab"),
header = FALSE, comment.char = "#", col.names = cols)
if(interactive()) View(tmp)
#endif
}
\keyword{utilities}
\keyword{chron}
| 8,145 |
gpl-2.0
|
63d0cb0c6d885871129fb61bffa9257883150b6c
|
hadley/r-source
|
src/library/base/man/as.POSIXlt.Rd
|
% File src/library/base/man/as.POSIXlt.Rd
% Part of the R package, http://www.R-project.org
% Copyright 1995-2014 R Core Team
% Distributed under GPL 2 or later
\name{as.POSIX*}
\alias{as.POSIXct}
\alias{as.POSIXct.default}
\alias{as.POSIXct.POSIXlt}
\alias{as.POSIXct.date}
\alias{as.POSIXct.dates}
\alias{as.POSIXct.Date}
\alias{as.POSIXct.numeric}
\alias{as.POSIXlt}
\alias{as.POSIXlt.Date}
\alias{as.POSIXlt.date}
\alias{as.POSIXlt.dates}
\alias{as.POSIXlt.POSIXct}
\alias{as.POSIXlt.factor}
\alias{as.POSIXlt.character}
\alias{as.POSIXlt.default}
\alias{as.POSIXlt.numeric}
\alias{as.double.POSIXlt}
\title{Date-time Conversion Functions}
\description{
Functions to manipulate objects of classes \code{"POSIXlt"} and
\code{"POSIXct"} representing calendar dates and times.
}
\usage{
as.POSIXct(x, tz = "", \dots)
as.POSIXlt(x, tz = "", \dots)
\method{as.POSIXlt}{character}(x, tz = "", format, \dots)
\method{as.POSIXlt}{numeric}(x, tz = "", origin, \dots)
\method{as.double}{POSIXlt}(x, \dots)
}
\arguments{
\item{x}{An object to be converted.}
\item{tz}{A time zone specification to be used for the conversion,
\emph{if one is required}. System-specific (see \link{time zones}),
but \code{""} is the current time zone, and \code{"GMT"} is UTC
(Universal Time, Coordinated). Invalid values are most commonly
treated as UTC, on some platforms with a warning.}
\item{\dots}{further arguments to be passed to or from other methods.}
\item{format}{character string giving a date-time format as used
by \code{\link{strptime}}.}
\item{origin}{a date-time object, or something which can be coerced by
\code{as.POSIXct(tz = "GMT")} to such an object.}
}
\details{
The \code{as.POSIX*} functions convert an object to one of the two
classes used to represent date/times (calendar dates plus time to the
nearest second). They can convert a wide variety of objects,
including objects of the other class and of classes \code{"Date"},
\code{"date"} (from package \pkg{\link[date:as.date]{date}}),
\code{"chron"} and \code{"dates"} (from package
\pkg{\link[chron]{chron}}) to these classes. Dates without times are
treated as being at midnight UTC.
They can also convert character strings of the formats
\code{"2001-02-03"} and \code{"2001/02/03"} optionally followed by
white space and a time in the format \code{"14:52"} or
\code{"14:52:03"}. (Formats such as \code{"01/02/03"} are ambiguous
but can be converted via a format specification by
\code{\link{strptime}}.) Fractional seconds are allowed.
Alternatively, \code{format} can be specified for character vectors or
factors: if it is not specified and no standard format works for
all non-\code{NA} inputs an error is thrown.
If \code{format} is specified, remember that some of the format
specifications are locale-specific, and you may need to set the
\code{LC_TIME} category appropriately \emph{via}
\code{\link{Sys.setlocale}}. This most often affects the use of
\code{\%b}, \code{\%B} (month names) and \code{\%p} (AM/PM).
Logical \code{NA}s can be converted to either of the classes, but no
other logical vectors can be.
If you are given a numeric time as the number of seconds since an
epoch, see the examples.
Character input is first converted to class \code{"POSIXlt"} by
\code{\link{strptime}}: numeric input is first converted to
\code{"POSIXct"}. Any conversion that needs to go between the two
date-time classes requires a time zone: conversion from
\code{"POSIXlt"} to \code{"POSIXct"} will validate times in the
selected time zone. One issue is what happens at transitions
to and from DST, for example in the UK
\preformatted{as.POSIXct(strptime("2011-03-27 01:30:00", "\%Y-\%m-\%d \%H:\%M:\%S"))
as.POSIXct(strptime("2010-10-31 01:30:00", "\%Y-\%m-\%d \%H:\%M:\%S"))
}
are respectively invalid (the clocks went forward at 1:00 GMT to 2:00
BST) and ambiguous (the clocks went back at 2:00 BST to 1:00 GMT). What
happens in such cases is OS-specific: one should expect the first to
be \code{NA}, but the second could be interpreted as either BST or
GMT (and common OSes give both possible values). Note too (see
\code{\link{strftime}}) that OS facilities may not format invalid
times correctly.
}
\value{
\code{as.POSIXct} and \code{as.POSIXlt} return an object of the
appropriate class. If \code{tz} was specified, \code{as.POSIXlt}
will give an appropriate \code{"tzone"} attribute. Date-times known
to be invalid will be returned as \code{NA}.
}
\note{
Some of the concepts used have to be extended backwards in time (the
usage is said to be \sQuote{proleptic}). For example, the origin of
time for the \code{"POSIXct"} class, \sQuote{1970-01-01 00:00.00 UTC},
is before UTC was defined. More importantly, conversion is done
assuming the Gregorian calendar which was introduced in 1582 and not
used universally until the 20th century. One of the
re-interpretations assumed by ISO 8601:2004 is that there was a year
zero, even though current year numbering (and zero) is a much later
concept (525 AD for year numbers from 1 AD).
If you want to extract specific aspects of a time (such as the day of
the week) just convert it to class \code{"POSIXlt"} and extract the
relevant component(s) of the list, or if you want a character
representation (such as a named day of the week) use the
\code{\link[base:format.POSIXlt]{format}} method.
If a time zone is needed and that specified is invalid on your system,
what happens is system-specific but attempts to set it will probably
be ignored.
Conversion from character needs to find a suitable format unless one
is supplied (by trying common formats in turn): this can be slow for
long inputs.
}
\seealso{
\link{DateTimeClasses} for details of the classes;
\code{\link{strptime}} for conversion to and from character
representations.
\code{\link{Sys.timezone}} for details of the (system-specific) naming
of time zones.
\link{locales} for locale-specific aspects.
}
\examples{\donttest{
(z <- Sys.time()) # the current datetime, as class "POSIXct"
unclass(z) # a large integer
floor(unclass(z)/86400) # the number of days since 1970-01-01 (UTC)
(now <- as.POSIXlt(Sys.time())) # the current datetime, as class "POSIXlt"
unlist(unclass(now)) # a list shown as a named vector
now$year + 1900 # see ?DateTimeClasses
months(now); weekdays(now) # see ?months
## suppose we have a time in seconds since 1960-01-01 00:00:00 GMT
## (the origin used by SAS)
z <- 1472562988
# ways to convert this
as.POSIXct(z, origin = "1960-01-01") # local
as.POSIXct(z, origin = "1960-01-01", tz = "GMT") # in UTC
## SPSS dates (R-help 2006-02-16)
z <- c(10485849600, 10477641600, 10561104000, 10562745600)
as.Date(as.POSIXct(z, origin = "1582-10-14", tz = "GMT"))
## Stata date-times: milliseconds since 1960-01-01 00:00:00 GMT
## format %tc excludes leap-seconds, assumed here
## For format %tC including leap seconds, see foreign::read.dta()
z <- 1579598122120
op <- options(digits.secs = 3)
# avoid rounding down: milliseconds are not exactly representable
as.POSIXct((z+0.1)/1000, origin = "1960-01-01")
options(op)
## Matlab 'serial day number' (days and fractional days)
z <- 7.343736909722223e5 # 2010-08-23 16:35:00
as.POSIXct((z - 719529)*86400, origin = "1970-01-01", tz = "UTC")
as.POSIXlt(Sys.time(), "GMT") # the current time in UTC
}
\donttest{## These may not be correct names on your system
as.POSIXlt(Sys.time(), "America/New_York") # in New York
as.POSIXlt(Sys.time(), "EST5EDT") # alternative.
as.POSIXlt(Sys.time(), "EST" ) # somewhere in Eastern Canada
as.POSIXlt(Sys.time(), "HST") # in Hawaii
as.POSIXlt(Sys.time(), "Australia/Darwin")
}
#ifdef windows
cols <- c("code", "coordinates", "TZ", "comments")
tmp <- read.delim(file.path(R.home("share"), "zoneinfo", "zone.tab"),
header = FALSE, comment.char = "#", col.names = cols)
if(interactive()) View(tmp)
#endif
}
\keyword{utilities}
\keyword{chron}
| 8,145 |
gpl-2.0
|
5a4a06a9b425e44f756efc5699765d8b5353fe10
|
lmccusker/d3treeR
|
man/renderD3tree.Rd
|
% Generated by roxygen2 (4.1.1): do not edit by hand
% Please edit documentation in R/d3tree.R
\name{renderD3tree}
\alias{renderD3tree}
\title{Widget render function for use in Shiny}
\usage{
renderD3tree(expr, env = parent.frame(), quoted = FALSE)
}
\description{
Widget render function for use in Shiny
}
| 308 |
mit
|
63d0cb0c6d885871129fb61bffa9257883150b6c
|
hxfeng/R-3.1.2
|
src/library/base/man/as.POSIXlt.Rd
|
% File src/library/base/man/as.POSIXlt.Rd
% Part of the R package, http://www.R-project.org
% Copyright 1995-2014 R Core Team
% Distributed under GPL 2 or later
\name{as.POSIX*}
\alias{as.POSIXct}
\alias{as.POSIXct.default}
\alias{as.POSIXct.POSIXlt}
\alias{as.POSIXct.date}
\alias{as.POSIXct.dates}
\alias{as.POSIXct.Date}
\alias{as.POSIXct.numeric}
\alias{as.POSIXlt}
\alias{as.POSIXlt.Date}
\alias{as.POSIXlt.date}
\alias{as.POSIXlt.dates}
\alias{as.POSIXlt.POSIXct}
\alias{as.POSIXlt.factor}
\alias{as.POSIXlt.character}
\alias{as.POSIXlt.default}
\alias{as.POSIXlt.numeric}
\alias{as.double.POSIXlt}
\title{Date-time Conversion Functions}
\description{
Functions to manipulate objects of classes \code{"POSIXlt"} and
\code{"POSIXct"} representing calendar dates and times.
}
\usage{
as.POSIXct(x, tz = "", \dots)
as.POSIXlt(x, tz = "", \dots)
\method{as.POSIXlt}{character}(x, tz = "", format, \dots)
\method{as.POSIXlt}{numeric}(x, tz = "", origin, \dots)
\method{as.double}{POSIXlt}(x, \dots)
}
\arguments{
\item{x}{An object to be converted.}
\item{tz}{A time zone specification to be used for the conversion,
\emph{if one is required}. System-specific (see \link{time zones}),
but \code{""} is the current time zone, and \code{"GMT"} is UTC
(Universal Time, Coordinated). Invalid values are most commonly
treated as UTC, on some platforms with a warning.}
\item{\dots}{further arguments to be passed to or from other methods.}
\item{format}{character string giving a date-time format as used
by \code{\link{strptime}}.}
\item{origin}{a date-time object, or something which can be coerced by
\code{as.POSIXct(tz = "GMT")} to such an object.}
}
\details{
The \code{as.POSIX*} functions convert an object to one of the two
classes used to represent date/times (calendar dates plus time to the
nearest second). They can convert a wide variety of objects,
including objects of the other class and of classes \code{"Date"},
\code{"date"} (from package \pkg{\link[date:as.date]{date}}),
\code{"chron"} and \code{"dates"} (from package
\pkg{\link[chron]{chron}}) to these classes. Dates without times are
treated as being at midnight UTC.
They can also convert character strings of the formats
\code{"2001-02-03"} and \code{"2001/02/03"} optionally followed by
white space and a time in the format \code{"14:52"} or
\code{"14:52:03"}. (Formats such as \code{"01/02/03"} are ambiguous
but can be converted via a format specification by
\code{\link{strptime}}.) Fractional seconds are allowed.
Alternatively, \code{format} can be specified for character vectors or
factors: if it is not specified and no standard format works for
all non-\code{NA} inputs an error is thrown.
If \code{format} is specified, remember that some of the format
specifications are locale-specific, and you may need to set the
\code{LC_TIME} category appropriately \emph{via}
\code{\link{Sys.setlocale}}. This most often affects the use of
\code{\%b}, \code{\%B} (month names) and \code{\%p} (AM/PM).
Logical \code{NA}s can be converted to either of the classes, but no
other logical vectors can be.
If you are given a numeric time as the number of seconds since an
epoch, see the examples.
Character input is first converted to class \code{"POSIXlt"} by
\code{\link{strptime}}: numeric input is first converted to
\code{"POSIXct"}. Any conversion that needs to go between the two
date-time classes requires a time zone: conversion from
\code{"POSIXlt"} to \code{"POSIXct"} will validate times in the
selected time zone. One issue is what happens at transitions
to and from DST, for example in the UK
\preformatted{as.POSIXct(strptime("2011-03-27 01:30:00", "\%Y-\%m-\%d \%H:\%M:\%S"))
as.POSIXct(strptime("2010-10-31 01:30:00", "\%Y-\%m-\%d \%H:\%M:\%S"))
}
are respectively invalid (the clocks went forward at 1:00 GMT to 2:00
BST) and ambiguous (the clocks went back at 2:00 BST to 1:00 GMT). What
happens in such cases is OS-specific: one should expect the first to
be \code{NA}, but the second could be interpreted as either BST or
GMT (and common OSes give both possible values). Note too (see
\code{\link{strftime}}) that OS facilities may not format invalid
times correctly.
}
\value{
\code{as.POSIXct} and \code{as.POSIXlt} return an object of the
appropriate class. If \code{tz} was specified, \code{as.POSIXlt}
will give an appropriate \code{"tzone"} attribute. Date-times known
to be invalid will be returned as \code{NA}.
}
\note{
Some of the concepts used have to be extended backwards in time (the
usage is said to be \sQuote{proleptic}). For example, the origin of
time for the \code{"POSIXct"} class, \sQuote{1970-01-01 00:00.00 UTC},
is before UTC was defined. More importantly, conversion is done
assuming the Gregorian calendar which was introduced in 1582 and not
used universally until the 20th century. One of the
re-interpretations assumed by ISO 8601:2004 is that there was a year
zero, even though current year numbering (and zero) is a much later
concept (525 AD for year numbers from 1 AD).
If you want to extract specific aspects of a time (such as the day of
the week) just convert it to class \code{"POSIXlt"} and extract the
relevant component(s) of the list, or if you want a character
representation (such as a named day of the week) use the
\code{\link[base:format.POSIXlt]{format}} method.
If a time zone is needed and that specified is invalid on your system,
what happens is system-specific but attempts to set it will probably
be ignored.
Conversion from character needs to find a suitable format unless one
is supplied (by trying common formats in turn): this can be slow for
long inputs.
}
\seealso{
\link{DateTimeClasses} for details of the classes;
\code{\link{strptime}} for conversion to and from character
representations.
\code{\link{Sys.timezone}} for details of the (system-specific) naming
of time zones.
\link{locales} for locale-specific aspects.
}
\examples{\donttest{
(z <- Sys.time()) # the current datetime, as class "POSIXct"
unclass(z) # a large integer
floor(unclass(z)/86400) # the number of days since 1970-01-01 (UTC)
(now <- as.POSIXlt(Sys.time())) # the current datetime, as class "POSIXlt"
unlist(unclass(now)) # a list shown as a named vector
now$year + 1900 # see ?DateTimeClasses
months(now); weekdays(now) # see ?months
## suppose we have a time in seconds since 1960-01-01 00:00:00 GMT
## (the origin used by SAS)
z <- 1472562988
# ways to convert this
as.POSIXct(z, origin = "1960-01-01") # local
as.POSIXct(z, origin = "1960-01-01", tz = "GMT") # in UTC
## SPSS dates (R-help 2006-02-16)
z <- c(10485849600, 10477641600, 10561104000, 10562745600)
as.Date(as.POSIXct(z, origin = "1582-10-14", tz = "GMT"))
## Stata date-times: milliseconds since 1960-01-01 00:00:00 GMT
## format %tc excludes leap-seconds, assumed here
## For format %tC including leap seconds, see foreign::read.dta()
z <- 1579598122120
op <- options(digits.secs = 3)
# avoid rounding down: milliseconds are not exactly representable
as.POSIXct((z+0.1)/1000, origin = "1960-01-01")
options(op)
## Matlab 'serial day number' (days and fractional days)
z <- 7.343736909722223e5 # 2010-08-23 16:35:00
as.POSIXct((z - 719529)*86400, origin = "1970-01-01", tz = "UTC")
as.POSIXlt(Sys.time(), "GMT") # the current time in UTC
}
\donttest{## These may not be correct names on your system
as.POSIXlt(Sys.time(), "America/New_York") # in New York
as.POSIXlt(Sys.time(), "EST5EDT") # alternative.
as.POSIXlt(Sys.time(), "EST" ) # somewhere in Eastern Canada
as.POSIXlt(Sys.time(), "HST") # in Hawaii
as.POSIXlt(Sys.time(), "Australia/Darwin")
}
#ifdef windows
cols <- c("code", "coordinates", "TZ", "comments")
tmp <- read.delim(file.path(R.home("share"), "zoneinfo", "zone.tab"),
header = FALSE, comment.char = "#", col.names = cols)
if(interactive()) View(tmp)
#endif
}
\keyword{utilities}
\keyword{chron}
| 8,145 |
gpl-2.0
|
2e9b1d92916be09d9ab6dd4e52d23f854388c1c3
|
UMMS-Biocore/debrowser
|
man/selectGroupInfo.Rd
|
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/funcs.R
\name{selectGroupInfo}
\alias{selectGroupInfo}
\title{selectGroupInfo}
\usage{
selectGroupInfo(
metadata = NULL,
input = NULL,
selectname = "groupselect",
label = "Group info"
)
}
\arguments{
\item{metadata, }{metadata}
\item{input, }{input values}
\item{selectname, }{name of the select box}
\item{label, }{label of the select box}
}
\description{
Group info column selection. This can be used in batch effect
or coloring the groups in the plots.
}
\note{
\code{selectGroupInfo}
}
\examples{
x <- selectGroupInfo()
}
| 619 |
gpl-3.0
|
63d0cb0c6d885871129fb61bffa9257883150b6c
|
jeffreyhorner/R-Judy-Arrays
|
src/library/base/man/as.POSIXlt.Rd
|
% File src/library/base/man/as.POSIXlt.Rd
% Part of the R package, http://www.R-project.org
% Copyright 1995-2014 R Core Team
% Distributed under GPL 2 or later
\name{as.POSIX*}
\alias{as.POSIXct}
\alias{as.POSIXct.default}
\alias{as.POSIXct.POSIXlt}
\alias{as.POSIXct.date}
\alias{as.POSIXct.dates}
\alias{as.POSIXct.Date}
\alias{as.POSIXct.numeric}
\alias{as.POSIXlt}
\alias{as.POSIXlt.Date}
\alias{as.POSIXlt.date}
\alias{as.POSIXlt.dates}
\alias{as.POSIXlt.POSIXct}
\alias{as.POSIXlt.factor}
\alias{as.POSIXlt.character}
\alias{as.POSIXlt.default}
\alias{as.POSIXlt.numeric}
\alias{as.double.POSIXlt}
\title{Date-time Conversion Functions}
\description{
Functions to manipulate objects of classes \code{"POSIXlt"} and
\code{"POSIXct"} representing calendar dates and times.
}
\usage{
as.POSIXct(x, tz = "", \dots)
as.POSIXlt(x, tz = "", \dots)
\method{as.POSIXlt}{character}(x, tz = "", format, \dots)
\method{as.POSIXlt}{numeric}(x, tz = "", origin, \dots)
\method{as.double}{POSIXlt}(x, \dots)
}
\arguments{
\item{x}{An object to be converted.}
\item{tz}{A time zone specification to be used for the conversion,
\emph{if one is required}. System-specific (see \link{time zones}),
but \code{""} is the current time zone, and \code{"GMT"} is UTC
(Universal Time, Coordinated). Invalid values are most commonly
treated as UTC, on some platforms with a warning.}
\item{\dots}{further arguments to be passed to or from other methods.}
\item{format}{character string giving a date-time format as used
by \code{\link{strptime}}.}
\item{origin}{a date-time object, or something which can be coerced by
\code{as.POSIXct(tz = "GMT")} to such an object.}
}
\details{
The \code{as.POSIX*} functions convert an object to one of the two
classes used to represent date/times (calendar dates plus time to the
nearest second). They can convert a wide variety of objects,
including objects of the other class and of classes \code{"Date"},
\code{"date"} (from package \pkg{\link[date:as.date]{date}}),
\code{"chron"} and \code{"dates"} (from package
\pkg{\link[chron]{chron}}) to these classes. Dates without times are
treated as being at midnight UTC.
They can also convert character strings of the formats
\code{"2001-02-03"} and \code{"2001/02/03"} optionally followed by
white space and a time in the format \code{"14:52"} or
\code{"14:52:03"}. (Formats such as \code{"01/02/03"} are ambiguous
but can be converted via a format specification by
\code{\link{strptime}}.) Fractional seconds are allowed.
Alternatively, \code{format} can be specified for character vectors or
factors: if it is not specified and no standard format works for
all non-\code{NA} inputs an error is thrown.
If \code{format} is specified, remember that some of the format
specifications are locale-specific, and you may need to set the
\code{LC_TIME} category appropriately \emph{via}
\code{\link{Sys.setlocale}}. This most often affects the use of
\code{\%b}, \code{\%B} (month names) and \code{\%p} (AM/PM).
Logical \code{NA}s can be converted to either of the classes, but no
other logical vectors can be.
If you are given a numeric time as the number of seconds since an
epoch, see the examples.
Character input is first converted to class \code{"POSIXlt"} by
\code{\link{strptime}}: numeric input is first converted to
\code{"POSIXct"}. Any conversion that needs to go between the two
date-time classes requires a time zone: conversion from
\code{"POSIXlt"} to \code{"POSIXct"} will validate times in the
selected time zone. One issue is what happens at transitions
to and from DST, for example in the UK
\preformatted{as.POSIXct(strptime("2011-03-27 01:30:00", "\%Y-\%m-\%d \%H:\%M:\%S"))
as.POSIXct(strptime("2010-10-31 01:30:00", "\%Y-\%m-\%d \%H:\%M:\%S"))
}
are respectively invalid (the clocks went forward at 1:00 GMT to 2:00
BST) and ambiguous (the clocks went back at 2:00 BST to 1:00 GMT). What
happens in such cases is OS-specific: one should expect the first to
be \code{NA}, but the second could be interpreted as either BST or
GMT (and common OSes give both possible values). Note too (see
\code{\link{strftime}}) that OS facilities may not format invalid
times correctly.
}
\value{
\code{as.POSIXct} and \code{as.POSIXlt} return an object of the
appropriate class. If \code{tz} was specified, \code{as.POSIXlt}
will give an appropriate \code{"tzone"} attribute. Date-times known
to be invalid will be returned as \code{NA}.
}
\note{
Some of the concepts used have to be extended backwards in time (the
usage is said to be \sQuote{proleptic}). For example, the origin of
time for the \code{"POSIXct"} class, \sQuote{1970-01-01 00:00.00 UTC},
is before UTC was defined. More importantly, conversion is done
assuming the Gregorian calendar which was introduced in 1582 and not
used universally until the 20th century. One of the
re-interpretations assumed by ISO 8601:2004 is that there was a year
zero, even though current year numbering (and zero) is a much later
concept (525 AD for year numbers from 1 AD).
If you want to extract specific aspects of a time (such as the day of
the week) just convert it to class \code{"POSIXlt"} and extract the
relevant component(s) of the list, or if you want a character
representation (such as a named day of the week) use the
\code{\link[base:format.POSIXlt]{format}} method.
If a time zone is needed and that specified is invalid on your system,
what happens is system-specific but attempts to set it will probably
be ignored.
Conversion from character needs to find a suitable format unless one
is supplied (by trying common formats in turn): this can be slow for
long inputs.
}
\seealso{
\link{DateTimeClasses} for details of the classes;
\code{\link{strptime}} for conversion to and from character
representations.
\code{\link{Sys.timezone}} for details of the (system-specific) naming
of time zones.
\link{locales} for locale-specific aspects.
}
\examples{\donttest{
(z <- Sys.time()) # the current datetime, as class "POSIXct"
unclass(z) # a large integer
floor(unclass(z)/86400) # the number of days since 1970-01-01 (UTC)
(now <- as.POSIXlt(Sys.time())) # the current datetime, as class "POSIXlt"
unlist(unclass(now)) # a list shown as a named vector
now$year + 1900 # see ?DateTimeClasses
months(now); weekdays(now) # see ?months
## suppose we have a time in seconds since 1960-01-01 00:00:00 GMT
## (the origin used by SAS)
z <- 1472562988
# ways to convert this
as.POSIXct(z, origin = "1960-01-01") # local
as.POSIXct(z, origin = "1960-01-01", tz = "GMT") # in UTC
## SPSS dates (R-help 2006-02-16)
z <- c(10485849600, 10477641600, 10561104000, 10562745600)
as.Date(as.POSIXct(z, origin = "1582-10-14", tz = "GMT"))
## Stata date-times: milliseconds since 1960-01-01 00:00:00 GMT
## format %tc excludes leap-seconds, assumed here
## For format %tC including leap seconds, see foreign::read.dta()
z <- 1579598122120
op <- options(digits.secs = 3)
# avoid rounding down: milliseconds are not exactly representable
as.POSIXct((z+0.1)/1000, origin = "1960-01-01")
options(op)
## Matlab 'serial day number' (days and fractional days)
z <- 7.343736909722223e5 # 2010-08-23 16:35:00
as.POSIXct((z - 719529)*86400, origin = "1970-01-01", tz = "UTC")
as.POSIXlt(Sys.time(), "GMT") # the current time in UTC
}
\donttest{## These may not be correct names on your system
as.POSIXlt(Sys.time(), "America/New_York") # in New York
as.POSIXlt(Sys.time(), "EST5EDT") # alternative.
as.POSIXlt(Sys.time(), "EST" ) # somewhere in Eastern Canada
as.POSIXlt(Sys.time(), "HST") # in Hawaii
as.POSIXlt(Sys.time(), "Australia/Darwin")
}
#ifdef windows
cols <- c("code", "coordinates", "TZ", "comments")
tmp <- read.delim(file.path(R.home("share"), "zoneinfo", "zone.tab"),
header = FALSE, comment.char = "#", col.names = cols)
if(interactive()) View(tmp)
#endif
}
\keyword{utilities}
\keyword{chron}
| 8,145 |
gpl-2.0
|
0a8bbb668592066d13425534bb4f4d2ab4b48545
|
johngarvin/R-2.1.1rcc
|
src/library/base/man/Math.Rd
|
\name{abs}
\title{Miscellaneous Mathematical Functions}
\usage{
abs(x)
sqrt(x)
}
\alias{abs}
\alias{sqrt}
\description{
These functions compute miscellaneous mathematical functions.
The naming follows the standard for computer languages
such as C or Fortran.
}
\arguments{
\item{x}{a numeric or \code{\link{complex}} vector or array.}
}
\details{
These are generic functions: methods can be defined for them
individually or via the \code{\link{Math}} group generic. For complex
arguments (and the default method), \code{z},
\code{abs(z) == \link{Mod}(z)} and \code{sqrt(z) == z^0.5}.
}
\seealso{
\code{\link{Arithmetic}} for simple, \code{\link{log}} for logarithmic,
\code{\link{sin}} for trigonometric, and \code{\link{Special}} for
special mathematical functions.
}
\references{
Becker, R. A., Chambers, J. M. and Wilks, A. R. (1988)
\emph{The New S Language}.
Wadsworth \& Brooks/Cole.
}
\examples{
require(stats) # for spline
xx <- -9:9
plot(xx, sqrt(abs(xx)), col = "red")
lines(spline(xx, sqrt(abs(xx)), n=101), col = "pink")
}
\keyword{math}
| 1,080 |
gpl-2.0
|
63d0cb0c6d885871129fb61bffa9257883150b6c
|
jagdeesh109/RRO
|
R-src/src/library/base/man/as.POSIXlt.Rd
|
% File src/library/base/man/as.POSIXlt.Rd
% Part of the R package, http://www.R-project.org
% Copyright 1995-2014 R Core Team
% Distributed under GPL 2 or later
\name{as.POSIX*}
\alias{as.POSIXct}
\alias{as.POSIXct.default}
\alias{as.POSIXct.POSIXlt}
\alias{as.POSIXct.date}
\alias{as.POSIXct.dates}
\alias{as.POSIXct.Date}
\alias{as.POSIXct.numeric}
\alias{as.POSIXlt}
\alias{as.POSIXlt.Date}
\alias{as.POSIXlt.date}
\alias{as.POSIXlt.dates}
\alias{as.POSIXlt.POSIXct}
\alias{as.POSIXlt.factor}
\alias{as.POSIXlt.character}
\alias{as.POSIXlt.default}
\alias{as.POSIXlt.numeric}
\alias{as.double.POSIXlt}
\title{Date-time Conversion Functions}
\description{
Functions to manipulate objects of classes \code{"POSIXlt"} and
\code{"POSIXct"} representing calendar dates and times.
}
\usage{
as.POSIXct(x, tz = "", \dots)
as.POSIXlt(x, tz = "", \dots)
\method{as.POSIXlt}{character}(x, tz = "", format, \dots)
\method{as.POSIXlt}{numeric}(x, tz = "", origin, \dots)
\method{as.double}{POSIXlt}(x, \dots)
}
\arguments{
\item{x}{An object to be converted.}
\item{tz}{A time zone specification to be used for the conversion,
\emph{if one is required}. System-specific (see \link{time zones}),
but \code{""} is the current time zone, and \code{"GMT"} is UTC
(Universal Time, Coordinated). Invalid values are most commonly
treated as UTC, on some platforms with a warning.}
\item{\dots}{further arguments to be passed to or from other methods.}
\item{format}{character string giving a date-time format as used
by \code{\link{strptime}}.}
\item{origin}{a date-time object, or something which can be coerced by
\code{as.POSIXct(tz = "GMT")} to such an object.}
}
\details{
The \code{as.POSIX*} functions convert an object to one of the two
classes used to represent date/times (calendar dates plus time to the
nearest second). They can convert a wide variety of objects,
including objects of the other class and of classes \code{"Date"},
\code{"date"} (from package \pkg{\link[date:as.date]{date}}),
\code{"chron"} and \code{"dates"} (from package
\pkg{\link[chron]{chron}}) to these classes. Dates without times are
treated as being at midnight UTC.
They can also convert character strings of the formats
\code{"2001-02-03"} and \code{"2001/02/03"} optionally followed by
white space and a time in the format \code{"14:52"} or
\code{"14:52:03"}. (Formats such as \code{"01/02/03"} are ambiguous
but can be converted via a format specification by
\code{\link{strptime}}.) Fractional seconds are allowed.
Alternatively, \code{format} can be specified for character vectors or
factors: if it is not specified and no standard format works for
all non-\code{NA} inputs an error is thrown.
If \code{format} is specified, remember that some of the format
specifications are locale-specific, and you may need to set the
\code{LC_TIME} category appropriately \emph{via}
\code{\link{Sys.setlocale}}. This most often affects the use of
\code{\%b}, \code{\%B} (month names) and \code{\%p} (AM/PM).
Logical \code{NA}s can be converted to either of the classes, but no
other logical vectors can be.
If you are given a numeric time as the number of seconds since an
epoch, see the examples.
Character input is first converted to class \code{"POSIXlt"} by
\code{\link{strptime}}: numeric input is first converted to
\code{"POSIXct"}. Any conversion that needs to go between the two
date-time classes requires a time zone: conversion from
\code{"POSIXlt"} to \code{"POSIXct"} will validate times in the
selected time zone. One issue is what happens at transitions
to and from DST, for example in the UK
\preformatted{as.POSIXct(strptime("2011-03-27 01:30:00", "\%Y-\%m-\%d \%H:\%M:\%S"))
as.POSIXct(strptime("2010-10-31 01:30:00", "\%Y-\%m-\%d \%H:\%M:\%S"))
}
are respectively invalid (the clocks went forward at 1:00 GMT to 2:00
BST) and ambiguous (the clocks went back at 2:00 BST to 1:00 GMT). What
happens in such cases is OS-specific: one should expect the first to
be \code{NA}, but the second could be interpreted as either BST or
GMT (and common OSes give both possible values). Note too (see
\code{\link{strftime}}) that OS facilities may not format invalid
times correctly.
}
\value{
\code{as.POSIXct} and \code{as.POSIXlt} return an object of the
appropriate class. If \code{tz} was specified, \code{as.POSIXlt}
will give an appropriate \code{"tzone"} attribute. Date-times known
to be invalid will be returned as \code{NA}.
}
\note{
Some of the concepts used have to be extended backwards in time (the
usage is said to be \sQuote{proleptic}). For example, the origin of
time for the \code{"POSIXct"} class, \sQuote{1970-01-01 00:00.00 UTC},
is before UTC was defined. More importantly, conversion is done
assuming the Gregorian calendar which was introduced in 1582 and not
used universally until the 20th century. One of the
re-interpretations assumed by ISO 8601:2004 is that there was a year
zero, even though current year numbering (and zero) is a much later
concept (525 AD for year numbers from 1 AD).
If you want to extract specific aspects of a time (such as the day of
the week) just convert it to class \code{"POSIXlt"} and extract the
relevant component(s) of the list, or if you want a character
representation (such as a named day of the week) use the
\code{\link[base:format.POSIXlt]{format}} method.
If a time zone is needed and that specified is invalid on your system,
what happens is system-specific but attempts to set it will probably
be ignored.
Conversion from character needs to find a suitable format unless one
is supplied (by trying common formats in turn): this can be slow for
long inputs.
}
\seealso{
\link{DateTimeClasses} for details of the classes;
\code{\link{strptime}} for conversion to and from character
representations.
\code{\link{Sys.timezone}} for details of the (system-specific) naming
of time zones.
\link{locales} for locale-specific aspects.
}
\examples{\donttest{
(z <- Sys.time()) # the current datetime, as class "POSIXct"
unclass(z) # a large integer
floor(unclass(z)/86400) # the number of days since 1970-01-01 (UTC)
(now <- as.POSIXlt(Sys.time())) # the current datetime, as class "POSIXlt"
unlist(unclass(now)) # a list shown as a named vector
now$year + 1900 # see ?DateTimeClasses
months(now); weekdays(now) # see ?months
## suppose we have a time in seconds since 1960-01-01 00:00:00 GMT
## (the origin used by SAS)
z <- 1472562988
# ways to convert this
as.POSIXct(z, origin = "1960-01-01") # local
as.POSIXct(z, origin = "1960-01-01", tz = "GMT") # in UTC
## SPSS dates (R-help 2006-02-16)
z <- c(10485849600, 10477641600, 10561104000, 10562745600)
as.Date(as.POSIXct(z, origin = "1582-10-14", tz = "GMT"))
## Stata date-times: milliseconds since 1960-01-01 00:00:00 GMT
## format %tc excludes leap-seconds, assumed here
## For format %tC including leap seconds, see foreign::read.dta()
z <- 1579598122120
op <- options(digits.secs = 3)
# avoid rounding down: milliseconds are not exactly representable
as.POSIXct((z+0.1)/1000, origin = "1960-01-01")
options(op)
## Matlab 'serial day number' (days and fractional days)
z <- 7.343736909722223e5 # 2010-08-23 16:35:00
as.POSIXct((z - 719529)*86400, origin = "1970-01-01", tz = "UTC")
as.POSIXlt(Sys.time(), "GMT") # the current time in UTC
}
\donttest{## These may not be correct names on your system
as.POSIXlt(Sys.time(), "America/New_York") # in New York
as.POSIXlt(Sys.time(), "EST5EDT") # alternative.
as.POSIXlt(Sys.time(), "EST" ) # somewhere in Eastern Canada
as.POSIXlt(Sys.time(), "HST") # in Hawaii
as.POSIXlt(Sys.time(), "Australia/Darwin")
}
#ifdef windows
cols <- c("code", "coordinates", "TZ", "comments")
tmp <- read.delim(file.path(R.home("share"), "zoneinfo", "zone.tab"),
header = FALSE, comment.char = "#", col.names = cols)
if(interactive()) View(tmp)
#endif
}
\keyword{utilities}
\keyword{chron}
| 8,145 |
gpl-2.0
|
63d0cb0c6d885871129fb61bffa9257883150b6c
|
patperry/r-source
|
src/library/base/man/as.POSIXlt.Rd
|
% File src/library/base/man/as.POSIXlt.Rd
% Part of the R package, http://www.R-project.org
% Copyright 1995-2014 R Core Team
% Distributed under GPL 2 or later
\name{as.POSIX*}
\alias{as.POSIXct}
\alias{as.POSIXct.default}
\alias{as.POSIXct.POSIXlt}
\alias{as.POSIXct.date}
\alias{as.POSIXct.dates}
\alias{as.POSIXct.Date}
\alias{as.POSIXct.numeric}
\alias{as.POSIXlt}
\alias{as.POSIXlt.Date}
\alias{as.POSIXlt.date}
\alias{as.POSIXlt.dates}
\alias{as.POSIXlt.POSIXct}
\alias{as.POSIXlt.factor}
\alias{as.POSIXlt.character}
\alias{as.POSIXlt.default}
\alias{as.POSIXlt.numeric}
\alias{as.double.POSIXlt}
\title{Date-time Conversion Functions}
\description{
Functions to manipulate objects of classes \code{"POSIXlt"} and
\code{"POSIXct"} representing calendar dates and times.
}
\usage{
as.POSIXct(x, tz = "", \dots)
as.POSIXlt(x, tz = "", \dots)
\method{as.POSIXlt}{character}(x, tz = "", format, \dots)
\method{as.POSIXlt}{numeric}(x, tz = "", origin, \dots)
\method{as.double}{POSIXlt}(x, \dots)
}
\arguments{
\item{x}{An object to be converted.}
\item{tz}{A time zone specification to be used for the conversion,
\emph{if one is required}. System-specific (see \link{time zones}),
but \code{""} is the current time zone, and \code{"GMT"} is UTC
(Universal Time, Coordinated). Invalid values are most commonly
treated as UTC, on some platforms with a warning.}
\item{\dots}{further arguments to be passed to or from other methods.}
\item{format}{character string giving a date-time format as used
by \code{\link{strptime}}.}
\item{origin}{a date-time object, or something which can be coerced by
\code{as.POSIXct(tz = "GMT")} to such an object.}
}
\details{
The \code{as.POSIX*} functions convert an object to one of the two
classes used to represent date/times (calendar dates plus time to the
nearest second). They can convert a wide variety of objects,
including objects of the other class and of classes \code{"Date"},
\code{"date"} (from package \pkg{\link[date:as.date]{date}}),
\code{"chron"} and \code{"dates"} (from package
\pkg{\link[chron]{chron}}) to these classes. Dates without times are
treated as being at midnight UTC.
They can also convert character strings of the formats
\code{"2001-02-03"} and \code{"2001/02/03"} optionally followed by
white space and a time in the format \code{"14:52"} or
\code{"14:52:03"}. (Formats such as \code{"01/02/03"} are ambiguous
but can be converted via a format specification by
\code{\link{strptime}}.) Fractional seconds are allowed.
Alternatively, \code{format} can be specified for character vectors or
factors: if it is not specified and no standard format works for
all non-\code{NA} inputs an error is thrown.
If \code{format} is specified, remember that some of the format
specifications are locale-specific, and you may need to set the
\code{LC_TIME} category appropriately \emph{via}
\code{\link{Sys.setlocale}}. This most often affects the use of
\code{\%b}, \code{\%B} (month names) and \code{\%p} (AM/PM).
Logical \code{NA}s can be converted to either of the classes, but no
other logical vectors can be.
If you are given a numeric time as the number of seconds since an
epoch, see the examples.
Character input is first converted to class \code{"POSIXlt"} by
\code{\link{strptime}}: numeric input is first converted to
\code{"POSIXct"}. Any conversion that needs to go between the two
date-time classes requires a time zone: conversion from
\code{"POSIXlt"} to \code{"POSIXct"} will validate times in the
selected time zone. One issue is what happens at transitions
to and from DST, for example in the UK
\preformatted{as.POSIXct(strptime("2011-03-27 01:30:00", "\%Y-\%m-\%d \%H:\%M:\%S"))
as.POSIXct(strptime("2010-10-31 01:30:00", "\%Y-\%m-\%d \%H:\%M:\%S"))
}
are respectively invalid (the clocks went forward at 1:00 GMT to 2:00
BST) and ambiguous (the clocks went back at 2:00 BST to 1:00 GMT). What
happens in such cases is OS-specific: one should expect the first to
be \code{NA}, but the second could be interpreted as either BST or
GMT (and common OSes give both possible values). Note too (see
\code{\link{strftime}}) that OS facilities may not format invalid
times correctly.
}
\value{
\code{as.POSIXct} and \code{as.POSIXlt} return an object of the
appropriate class. If \code{tz} was specified, \code{as.POSIXlt}
will give an appropriate \code{"tzone"} attribute. Date-times known
to be invalid will be returned as \code{NA}.
}
\note{
Some of the concepts used have to be extended backwards in time (the
usage is said to be \sQuote{proleptic}). For example, the origin of
time for the \code{"POSIXct"} class, \sQuote{1970-01-01 00:00.00 UTC},
is before UTC was defined. More importantly, conversion is done
assuming the Gregorian calendar which was introduced in 1582 and not
used universally until the 20th century. One of the
re-interpretations assumed by ISO 8601:2004 is that there was a year
zero, even though current year numbering (and zero) is a much later
concept (525 AD for year numbers from 1 AD).
If you want to extract specific aspects of a time (such as the day of
the week) just convert it to class \code{"POSIXlt"} and extract the
relevant component(s) of the list, or if you want a character
representation (such as a named day of the week) use the
\code{\link[base:format.POSIXlt]{format}} method.
If a time zone is needed and that specified is invalid on your system,
what happens is system-specific but attempts to set it will probably
be ignored.
Conversion from character needs to find a suitable format unless one
is supplied (by trying common formats in turn): this can be slow for
long inputs.
}
\seealso{
\link{DateTimeClasses} for details of the classes;
\code{\link{strptime}} for conversion to and from character
representations.
\code{\link{Sys.timezone}} for details of the (system-specific) naming
of time zones.
\link{locales} for locale-specific aspects.
}
\examples{\donttest{
(z <- Sys.time()) # the current datetime, as class "POSIXct"
unclass(z) # a large integer
floor(unclass(z)/86400) # the number of days since 1970-01-01 (UTC)
(now <- as.POSIXlt(Sys.time())) # the current datetime, as class "POSIXlt"
unlist(unclass(now)) # a list shown as a named vector
now$year + 1900 # see ?DateTimeClasses
months(now); weekdays(now) # see ?months
## suppose we have a time in seconds since 1960-01-01 00:00:00 GMT
## (the origin used by SAS)
z <- 1472562988
# ways to convert this
as.POSIXct(z, origin = "1960-01-01") # local
as.POSIXct(z, origin = "1960-01-01", tz = "GMT") # in UTC
## SPSS dates (R-help 2006-02-16)
z <- c(10485849600, 10477641600, 10561104000, 10562745600)
as.Date(as.POSIXct(z, origin = "1582-10-14", tz = "GMT"))
## Stata date-times: milliseconds since 1960-01-01 00:00:00 GMT
## format %tc excludes leap-seconds, assumed here
## For format %tC including leap seconds, see foreign::read.dta()
z <- 1579598122120
op <- options(digits.secs = 3)
# avoid rounding down: milliseconds are not exactly representable
as.POSIXct((z+0.1)/1000, origin = "1960-01-01")
options(op)
## Matlab 'serial day number' (days and fractional days)
z <- 7.343736909722223e5 # 2010-08-23 16:35:00
as.POSIXct((z - 719529)*86400, origin = "1970-01-01", tz = "UTC")
as.POSIXlt(Sys.time(), "GMT") # the current time in UTC
}
\donttest{## These may not be correct names on your system
as.POSIXlt(Sys.time(), "America/New_York") # in New York
as.POSIXlt(Sys.time(), "EST5EDT") # alternative.
as.POSIXlt(Sys.time(), "EST" ) # somewhere in Eastern Canada
as.POSIXlt(Sys.time(), "HST") # in Hawaii
as.POSIXlt(Sys.time(), "Australia/Darwin")
}
#ifdef windows
cols <- c("code", "coordinates", "TZ", "comments")
tmp <- read.delim(file.path(R.home("share"), "zoneinfo", "zone.tab"),
header = FALSE, comment.char = "#", col.names = cols)
if(interactive()) View(tmp)
#endif
}
\keyword{utilities}
\keyword{chron}
| 8,145 |
gpl-2.0
|
63d0cb0c6d885871129fb61bffa9257883150b6c
|
skyguy94/R
|
src/library/base/man/as.POSIXlt.Rd
|
% File src/library/base/man/as.POSIXlt.Rd
% Part of the R package, http://www.R-project.org
% Copyright 1995-2014 R Core Team
% Distributed under GPL 2 or later
\name{as.POSIX*}
\alias{as.POSIXct}
\alias{as.POSIXct.default}
\alias{as.POSIXct.POSIXlt}
\alias{as.POSIXct.date}
\alias{as.POSIXct.dates}
\alias{as.POSIXct.Date}
\alias{as.POSIXct.numeric}
\alias{as.POSIXlt}
\alias{as.POSIXlt.Date}
\alias{as.POSIXlt.date}
\alias{as.POSIXlt.dates}
\alias{as.POSIXlt.POSIXct}
\alias{as.POSIXlt.factor}
\alias{as.POSIXlt.character}
\alias{as.POSIXlt.default}
\alias{as.POSIXlt.numeric}
\alias{as.double.POSIXlt}
\title{Date-time Conversion Functions}
\description{
Functions to manipulate objects of classes \code{"POSIXlt"} and
\code{"POSIXct"} representing calendar dates and times.
}
\usage{
as.POSIXct(x, tz = "", \dots)
as.POSIXlt(x, tz = "", \dots)
\method{as.POSIXlt}{character}(x, tz = "", format, \dots)
\method{as.POSIXlt}{numeric}(x, tz = "", origin, \dots)
\method{as.double}{POSIXlt}(x, \dots)
}
\arguments{
\item{x}{An object to be converted.}
\item{tz}{A time zone specification to be used for the conversion,
\emph{if one is required}. System-specific (see \link{time zones}),
but \code{""} is the current time zone, and \code{"GMT"} is UTC
(Universal Time, Coordinated). Invalid values are most commonly
treated as UTC, on some platforms with a warning.}
\item{\dots}{further arguments to be passed to or from other methods.}
\item{format}{character string giving a date-time format as used
by \code{\link{strptime}}.}
\item{origin}{a date-time object, or something which can be coerced by
\code{as.POSIXct(tz = "GMT")} to such an object.}
}
\details{
The \code{as.POSIX*} functions convert an object to one of the two
classes used to represent date/times (calendar dates plus time to the
nearest second). They can convert a wide variety of objects,
including objects of the other class and of classes \code{"Date"},
\code{"date"} (from package \pkg{\link[date:as.date]{date}}),
\code{"chron"} and \code{"dates"} (from package
\pkg{\link[chron]{chron}}) to these classes. Dates without times are
treated as being at midnight UTC.
They can also convert character strings of the formats
\code{"2001-02-03"} and \code{"2001/02/03"} optionally followed by
white space and a time in the format \code{"14:52"} or
\code{"14:52:03"}. (Formats such as \code{"01/02/03"} are ambiguous
but can be converted via a format specification by
\code{\link{strptime}}.) Fractional seconds are allowed.
Alternatively, \code{format} can be specified for character vectors or
factors: if it is not specified and no standard format works for
all non-\code{NA} inputs an error is thrown.
If \code{format} is specified, remember that some of the format
specifications are locale-specific, and you may need to set the
\code{LC_TIME} category appropriately \emph{via}
\code{\link{Sys.setlocale}}. This most often affects the use of
\code{\%b}, \code{\%B} (month names) and \code{\%p} (AM/PM).
Logical \code{NA}s can be converted to either of the classes, but no
other logical vectors can be.
If you are given a numeric time as the number of seconds since an
epoch, see the examples.
Character input is first converted to class \code{"POSIXlt"} by
\code{\link{strptime}}: numeric input is first converted to
\code{"POSIXct"}. Any conversion that needs to go between the two
date-time classes requires a time zone: conversion from
\code{"POSIXlt"} to \code{"POSIXct"} will validate times in the
selected time zone. One issue is what happens at transitions
to and from DST, for example in the UK
\preformatted{as.POSIXct(strptime("2011-03-27 01:30:00", "\%Y-\%m-\%d \%H:\%M:\%S"))
as.POSIXct(strptime("2010-10-31 01:30:00", "\%Y-\%m-\%d \%H:\%M:\%S"))
}
are respectively invalid (the clocks went forward at 1:00 GMT to 2:00
BST) and ambiguous (the clocks went back at 2:00 BST to 1:00 GMT). What
happens in such cases is OS-specific: one should expect the first to
be \code{NA}, but the second could be interpreted as either BST or
GMT (and common OSes give both possible values). Note too (see
\code{\link{strftime}}) that OS facilities may not format invalid
times correctly.
}
\value{
\code{as.POSIXct} and \code{as.POSIXlt} return an object of the
appropriate class. If \code{tz} was specified, \code{as.POSIXlt}
will give an appropriate \code{"tzone"} attribute. Date-times known
to be invalid will be returned as \code{NA}.
}
\note{
Some of the concepts used have to be extended backwards in time (the
usage is said to be \sQuote{proleptic}). For example, the origin of
time for the \code{"POSIXct"} class, \sQuote{1970-01-01 00:00.00 UTC},
is before UTC was defined. More importantly, conversion is done
assuming the Gregorian calendar which was introduced in 1582 and not
used universally until the 20th century. One of the
re-interpretations assumed by ISO 8601:2004 is that there was a year
zero, even though current year numbering (and zero) is a much later
concept (525 AD for year numbers from 1 AD).
If you want to extract specific aspects of a time (such as the day of
the week) just convert it to class \code{"POSIXlt"} and extract the
relevant component(s) of the list, or if you want a character
representation (such as a named day of the week) use the
\code{\link[base:format.POSIXlt]{format}} method.
If a time zone is needed and that specified is invalid on your system,
what happens is system-specific but attempts to set it will probably
be ignored.
Conversion from character needs to find a suitable format unless one
is supplied (by trying common formats in turn): this can be slow for
long inputs.
}
\seealso{
\link{DateTimeClasses} for details of the classes;
\code{\link{strptime}} for conversion to and from character
representations.
\code{\link{Sys.timezone}} for details of the (system-specific) naming
of time zones.
\link{locales} for locale-specific aspects.
}
\examples{\donttest{
(z <- Sys.time()) # the current datetime, as class "POSIXct"
unclass(z) # a large integer
floor(unclass(z)/86400) # the number of days since 1970-01-01 (UTC)
(now <- as.POSIXlt(Sys.time())) # the current datetime, as class "POSIXlt"
unlist(unclass(now)) # a list shown as a named vector
now$year + 1900 # see ?DateTimeClasses
months(now); weekdays(now) # see ?months
## suppose we have a time in seconds since 1960-01-01 00:00:00 GMT
## (the origin used by SAS)
z <- 1472562988
# ways to convert this
as.POSIXct(z, origin = "1960-01-01") # local
as.POSIXct(z, origin = "1960-01-01", tz = "GMT") # in UTC
## SPSS dates (R-help 2006-02-16)
z <- c(10485849600, 10477641600, 10561104000, 10562745600)
as.Date(as.POSIXct(z, origin = "1582-10-14", tz = "GMT"))
## Stata date-times: milliseconds since 1960-01-01 00:00:00 GMT
## format %tc excludes leap-seconds, assumed here
## For format %tC including leap seconds, see foreign::read.dta()
z <- 1579598122120
op <- options(digits.secs = 3)
# avoid rounding down: milliseconds are not exactly representable
as.POSIXct((z+0.1)/1000, origin = "1960-01-01")
options(op)
## Matlab 'serial day number' (days and fractional days)
z <- 7.343736909722223e5 # 2010-08-23 16:35:00
as.POSIXct((z - 719529)*86400, origin = "1970-01-01", tz = "UTC")
as.POSIXlt(Sys.time(), "GMT") # the current time in UTC
}
\donttest{## These may not be correct names on your system
as.POSIXlt(Sys.time(), "America/New_York") # in New York
as.POSIXlt(Sys.time(), "EST5EDT") # alternative.
as.POSIXlt(Sys.time(), "EST" ) # somewhere in Eastern Canada
as.POSIXlt(Sys.time(), "HST") # in Hawaii
as.POSIXlt(Sys.time(), "Australia/Darwin")
}
#ifdef windows
cols <- c("code", "coordinates", "TZ", "comments")
tmp <- read.delim(file.path(R.home("share"), "zoneinfo", "zone.tab"),
header = FALSE, comment.char = "#", col.names = cols)
if(interactive()) View(tmp)
#endif
}
\keyword{utilities}
\keyword{chron}
| 8,145 |
gpl-2.0
|
63d0cb0c6d885871129fb61bffa9257883150b6c
|
o-/Rexperiments
|
src/library/base/man/as.POSIXlt.Rd
|
% File src/library/base/man/as.POSIXlt.Rd
% Part of the R package, http://www.R-project.org
% Copyright 1995-2014 R Core Team
% Distributed under GPL 2 or later
\name{as.POSIX*}
\alias{as.POSIXct}
\alias{as.POSIXct.default}
\alias{as.POSIXct.POSIXlt}
\alias{as.POSIXct.date}
\alias{as.POSIXct.dates}
\alias{as.POSIXct.Date}
\alias{as.POSIXct.numeric}
\alias{as.POSIXlt}
\alias{as.POSIXlt.Date}
\alias{as.POSIXlt.date}
\alias{as.POSIXlt.dates}
\alias{as.POSIXlt.POSIXct}
\alias{as.POSIXlt.factor}
\alias{as.POSIXlt.character}
\alias{as.POSIXlt.default}
\alias{as.POSIXlt.numeric}
\alias{as.double.POSIXlt}
\title{Date-time Conversion Functions}
\description{
Functions to manipulate objects of classes \code{"POSIXlt"} and
\code{"POSIXct"} representing calendar dates and times.
}
\usage{
as.POSIXct(x, tz = "", \dots)
as.POSIXlt(x, tz = "", \dots)
\method{as.POSIXlt}{character}(x, tz = "", format, \dots)
\method{as.POSIXlt}{numeric}(x, tz = "", origin, \dots)
\method{as.double}{POSIXlt}(x, \dots)
}
\arguments{
\item{x}{An object to be converted.}
\item{tz}{A time zone specification to be used for the conversion,
\emph{if one is required}. System-specific (see \link{time zones}),
but \code{""} is the current time zone, and \code{"GMT"} is UTC
(Universal Time, Coordinated). Invalid values are most commonly
treated as UTC, on some platforms with a warning.}
\item{\dots}{further arguments to be passed to or from other methods.}
\item{format}{character string giving a date-time format as used
by \code{\link{strptime}}.}
\item{origin}{a date-time object, or something which can be coerced by
\code{as.POSIXct(tz = "GMT")} to such an object.}
}
\details{
The \code{as.POSIX*} functions convert an object to one of the two
classes used to represent date/times (calendar dates plus time to the
nearest second). They can convert a wide variety of objects,
including objects of the other class and of classes \code{"Date"},
\code{"date"} (from package \pkg{\link[date:as.date]{date}}),
\code{"chron"} and \code{"dates"} (from package
\pkg{\link[chron]{chron}}) to these classes. Dates without times are
treated as being at midnight UTC.
They can also convert character strings of the formats
\code{"2001-02-03"} and \code{"2001/02/03"} optionally followed by
white space and a time in the format \code{"14:52"} or
\code{"14:52:03"}. (Formats such as \code{"01/02/03"} are ambiguous
but can be converted via a format specification by
\code{\link{strptime}}.) Fractional seconds are allowed.
Alternatively, \code{format} can be specified for character vectors or
factors: if it is not specified and no standard format works for
all non-\code{NA} inputs an error is thrown.
If \code{format} is specified, remember that some of the format
specifications are locale-specific, and you may need to set the
\code{LC_TIME} category appropriately \emph{via}
\code{\link{Sys.setlocale}}. This most often affects the use of
\code{\%b}, \code{\%B} (month names) and \code{\%p} (AM/PM).
Logical \code{NA}s can be converted to either of the classes, but no
other logical vectors can be.
If you are given a numeric time as the number of seconds since an
epoch, see the examples.
Character input is first converted to class \code{"POSIXlt"} by
\code{\link{strptime}}: numeric input is first converted to
\code{"POSIXct"}. Any conversion that needs to go between the two
date-time classes requires a time zone: conversion from
\code{"POSIXlt"} to \code{"POSIXct"} will validate times in the
selected time zone. One issue is what happens at transitions
to and from DST, for example in the UK
\preformatted{as.POSIXct(strptime("2011-03-27 01:30:00", "\%Y-\%m-\%d \%H:\%M:\%S"))
as.POSIXct(strptime("2010-10-31 01:30:00", "\%Y-\%m-\%d \%H:\%M:\%S"))
}
are respectively invalid (the clocks went forward at 1:00 GMT to 2:00
BST) and ambiguous (the clocks went back at 2:00 BST to 1:00 GMT). What
happens in such cases is OS-specific: one should expect the first to
be \code{NA}, but the second could be interpreted as either BST or
GMT (and common OSes give both possible values). Note too (see
\code{\link{strftime}}) that OS facilities may not format invalid
times correctly.
}
\value{
\code{as.POSIXct} and \code{as.POSIXlt} return an object of the
appropriate class. If \code{tz} was specified, \code{as.POSIXlt}
will give an appropriate \code{"tzone"} attribute. Date-times known
to be invalid will be returned as \code{NA}.
}
\note{
Some of the concepts used have to be extended backwards in time (the
usage is said to be \sQuote{proleptic}). For example, the origin of
time for the \code{"POSIXct"} class, \sQuote{1970-01-01 00:00.00 UTC},
is before UTC was defined. More importantly, conversion is done
assuming the Gregorian calendar which was introduced in 1582 and not
used universally until the 20th century. One of the
re-interpretations assumed by ISO 8601:2004 is that there was a year
zero, even though current year numbering (and zero) is a much later
concept (525 AD for year numbers from 1 AD).
If you want to extract specific aspects of a time (such as the day of
the week) just convert it to class \code{"POSIXlt"} and extract the
relevant component(s) of the list, or if you want a character
representation (such as a named day of the week) use the
\code{\link[base:format.POSIXlt]{format}} method.
If a time zone is needed and that specified is invalid on your system,
what happens is system-specific but attempts to set it will probably
be ignored.
Conversion from character needs to find a suitable format unless one
is supplied (by trying common formats in turn): this can be slow for
long inputs.
}
\seealso{
\link{DateTimeClasses} for details of the classes;
\code{\link{strptime}} for conversion to and from character
representations.
\code{\link{Sys.timezone}} for details of the (system-specific) naming
of time zones.
\link{locales} for locale-specific aspects.
}
\examples{\donttest{
(z <- Sys.time()) # the current datetime, as class "POSIXct"
unclass(z) # a large integer
floor(unclass(z)/86400) # the number of days since 1970-01-01 (UTC)
(now <- as.POSIXlt(Sys.time())) # the current datetime, as class "POSIXlt"
unlist(unclass(now)) # a list shown as a named vector
now$year + 1900 # see ?DateTimeClasses
months(now); weekdays(now) # see ?months
## suppose we have a time in seconds since 1960-01-01 00:00:00 GMT
## (the origin used by SAS)
z <- 1472562988
# ways to convert this
as.POSIXct(z, origin = "1960-01-01") # local
as.POSIXct(z, origin = "1960-01-01", tz = "GMT") # in UTC
## SPSS dates (R-help 2006-02-16)
z <- c(10485849600, 10477641600, 10561104000, 10562745600)
as.Date(as.POSIXct(z, origin = "1582-10-14", tz = "GMT"))
## Stata date-times: milliseconds since 1960-01-01 00:00:00 GMT
## format %tc excludes leap-seconds, assumed here
## For format %tC including leap seconds, see foreign::read.dta()
z <- 1579598122120
op <- options(digits.secs = 3)
# avoid rounding down: milliseconds are not exactly representable
as.POSIXct((z+0.1)/1000, origin = "1960-01-01")
options(op)
## Matlab 'serial day number' (days and fractional days)
z <- 7.343736909722223e5 # 2010-08-23 16:35:00
as.POSIXct((z - 719529)*86400, origin = "1970-01-01", tz = "UTC")
as.POSIXlt(Sys.time(), "GMT") # the current time in UTC
}
\donttest{## These may not be correct names on your system
as.POSIXlt(Sys.time(), "America/New_York") # in New York
as.POSIXlt(Sys.time(), "EST5EDT") # alternative.
as.POSIXlt(Sys.time(), "EST" ) # somewhere in Eastern Canada
as.POSIXlt(Sys.time(), "HST") # in Hawaii
as.POSIXlt(Sys.time(), "Australia/Darwin")
}
#ifdef windows
cols <- c("code", "coordinates", "TZ", "comments")
tmp <- read.delim(file.path(R.home("share"), "zoneinfo", "zone.tab"),
header = FALSE, comment.char = "#", col.names = cols)
if(interactive()) View(tmp)
#endif
}
\keyword{utilities}
\keyword{chron}
| 8,145 |
gpl-2.0
|
63d0cb0c6d885871129fb61bffa9257883150b6c
|
jeffreyhorner/R-Array-Hash
|
src/library/base/man/as.POSIXlt.Rd
|
% File src/library/base/man/as.POSIXlt.Rd
% Part of the R package, http://www.R-project.org
% Copyright 1995-2014 R Core Team
% Distributed under GPL 2 or later
\name{as.POSIX*}
\alias{as.POSIXct}
\alias{as.POSIXct.default}
\alias{as.POSIXct.POSIXlt}
\alias{as.POSIXct.date}
\alias{as.POSIXct.dates}
\alias{as.POSIXct.Date}
\alias{as.POSIXct.numeric}
\alias{as.POSIXlt}
\alias{as.POSIXlt.Date}
\alias{as.POSIXlt.date}
\alias{as.POSIXlt.dates}
\alias{as.POSIXlt.POSIXct}
\alias{as.POSIXlt.factor}
\alias{as.POSIXlt.character}
\alias{as.POSIXlt.default}
\alias{as.POSIXlt.numeric}
\alias{as.double.POSIXlt}
\title{Date-time Conversion Functions}
\description{
Functions to manipulate objects of classes \code{"POSIXlt"} and
\code{"POSIXct"} representing calendar dates and times.
}
\usage{
as.POSIXct(x, tz = "", \dots)
as.POSIXlt(x, tz = "", \dots)
\method{as.POSIXlt}{character}(x, tz = "", format, \dots)
\method{as.POSIXlt}{numeric}(x, tz = "", origin, \dots)
\method{as.double}{POSIXlt}(x, \dots)
}
\arguments{
\item{x}{An object to be converted.}
\item{tz}{A time zone specification to be used for the conversion,
\emph{if one is required}. System-specific (see \link{time zones}),
but \code{""} is the current time zone, and \code{"GMT"} is UTC
(Universal Time, Coordinated). Invalid values are most commonly
treated as UTC, on some platforms with a warning.}
\item{\dots}{further arguments to be passed to or from other methods.}
\item{format}{character string giving a date-time format as used
by \code{\link{strptime}}.}
\item{origin}{a date-time object, or something which can be coerced by
\code{as.POSIXct(tz = "GMT")} to such an object.}
}
\details{
The \code{as.POSIX*} functions convert an object to one of the two
classes used to represent date/times (calendar dates plus time to the
nearest second). They can convert a wide variety of objects,
including objects of the other class and of classes \code{"Date"},
\code{"date"} (from package \pkg{\link[date:as.date]{date}}),
\code{"chron"} and \code{"dates"} (from package
\pkg{\link[chron]{chron}}) to these classes. Dates without times are
treated as being at midnight UTC.
They can also convert character strings of the formats
\code{"2001-02-03"} and \code{"2001/02/03"} optionally followed by
white space and a time in the format \code{"14:52"} or
\code{"14:52:03"}. (Formats such as \code{"01/02/03"} are ambiguous
but can be converted via a format specification by
\code{\link{strptime}}.) Fractional seconds are allowed.
Alternatively, \code{format} can be specified for character vectors or
factors: if it is not specified and no standard format works for
all non-\code{NA} inputs an error is thrown.
If \code{format} is specified, remember that some of the format
specifications are locale-specific, and you may need to set the
\code{LC_TIME} category appropriately \emph{via}
\code{\link{Sys.setlocale}}. This most often affects the use of
\code{\%b}, \code{\%B} (month names) and \code{\%p} (AM/PM).
Logical \code{NA}s can be converted to either of the classes, but no
other logical vectors can be.
If you are given a numeric time as the number of seconds since an
epoch, see the examples.
Character input is first converted to class \code{"POSIXlt"} by
\code{\link{strptime}}: numeric input is first converted to
\code{"POSIXct"}. Any conversion that needs to go between the two
date-time classes requires a time zone: conversion from
\code{"POSIXlt"} to \code{"POSIXct"} will validate times in the
selected time zone. One issue is what happens at transitions
to and from DST, for example in the UK
\preformatted{as.POSIXct(strptime("2011-03-27 01:30:00", "\%Y-\%m-\%d \%H:\%M:\%S"))
as.POSIXct(strptime("2010-10-31 01:30:00", "\%Y-\%m-\%d \%H:\%M:\%S"))
}
are respectively invalid (the clocks went forward at 1:00 GMT to 2:00
BST) and ambiguous (the clocks went back at 2:00 BST to 1:00 GMT). What
happens in such cases is OS-specific: one should expect the first to
be \code{NA}, but the second could be interpreted as either BST or
GMT (and common OSes give both possible values). Note too (see
\code{\link{strftime}}) that OS facilities may not format invalid
times correctly.
}
\value{
\code{as.POSIXct} and \code{as.POSIXlt} return an object of the
appropriate class. If \code{tz} was specified, \code{as.POSIXlt}
will give an appropriate \code{"tzone"} attribute. Date-times known
to be invalid will be returned as \code{NA}.
}
\note{
Some of the concepts used have to be extended backwards in time (the
usage is said to be \sQuote{proleptic}). For example, the origin of
time for the \code{"POSIXct"} class, \sQuote{1970-01-01 00:00.00 UTC},
is before UTC was defined. More importantly, conversion is done
assuming the Gregorian calendar which was introduced in 1582 and not
used universally until the 20th century. One of the
re-interpretations assumed by ISO 8601:2004 is that there was a year
zero, even though current year numbering (and zero) is a much later
concept (525 AD for year numbers from 1 AD).
If you want to extract specific aspects of a time (such as the day of
the week) just convert it to class \code{"POSIXlt"} and extract the
relevant component(s) of the list, or if you want a character
representation (such as a named day of the week) use the
\code{\link[base:format.POSIXlt]{format}} method.
If a time zone is needed and that specified is invalid on your system,
what happens is system-specific but attempts to set it will probably
be ignored.
Conversion from character needs to find a suitable format unless one
is supplied (by trying common formats in turn): this can be slow for
long inputs.
}
\seealso{
\link{DateTimeClasses} for details of the classes;
\code{\link{strptime}} for conversion to and from character
representations.
\code{\link{Sys.timezone}} for details of the (system-specific) naming
of time zones.
\link{locales} for locale-specific aspects.
}
\examples{\donttest{
(z <- Sys.time()) # the current datetime, as class "POSIXct"
unclass(z) # a large integer
floor(unclass(z)/86400) # the number of days since 1970-01-01 (UTC)
(now <- as.POSIXlt(Sys.time())) # the current datetime, as class "POSIXlt"
unlist(unclass(now)) # a list shown as a named vector
now$year + 1900 # see ?DateTimeClasses
months(now); weekdays(now) # see ?months
## suppose we have a time in seconds since 1960-01-01 00:00:00 GMT
## (the origin used by SAS)
z <- 1472562988
# ways to convert this
as.POSIXct(z, origin = "1960-01-01") # local
as.POSIXct(z, origin = "1960-01-01", tz = "GMT") # in UTC
## SPSS dates (R-help 2006-02-16)
z <- c(10485849600, 10477641600, 10561104000, 10562745600)
as.Date(as.POSIXct(z, origin = "1582-10-14", tz = "GMT"))
## Stata date-times: milliseconds since 1960-01-01 00:00:00 GMT
## format %tc excludes leap-seconds, assumed here
## For format %tC including leap seconds, see foreign::read.dta()
z <- 1579598122120
op <- options(digits.secs = 3)
# avoid rounding down: milliseconds are not exactly representable
as.POSIXct((z+0.1)/1000, origin = "1960-01-01")
options(op)
## Matlab 'serial day number' (days and fractional days)
z <- 7.343736909722223e5 # 2010-08-23 16:35:00
as.POSIXct((z - 719529)*86400, origin = "1970-01-01", tz = "UTC")
as.POSIXlt(Sys.time(), "GMT") # the current time in UTC
}
\donttest{## These may not be correct names on your system
as.POSIXlt(Sys.time(), "America/New_York") # in New York
as.POSIXlt(Sys.time(), "EST5EDT") # alternative.
as.POSIXlt(Sys.time(), "EST" ) # somewhere in Eastern Canada
as.POSIXlt(Sys.time(), "HST") # in Hawaii
as.POSIXlt(Sys.time(), "Australia/Darwin")
}
#ifdef windows
cols <- c("code", "coordinates", "TZ", "comments")
tmp <- read.delim(file.path(R.home("share"), "zoneinfo", "zone.tab"),
header = FALSE, comment.char = "#", col.names = cols)
if(interactive()) View(tmp)
#endif
}
\keyword{utilities}
\keyword{chron}
| 8,145 |
gpl-2.0
|
63d0cb0c6d885871129fb61bffa9257883150b6c
|
ChiWang/r-source
|
src/library/base/man/as.POSIXlt.Rd
|
% File src/library/base/man/as.POSIXlt.Rd
% Part of the R package, http://www.R-project.org
% Copyright 1995-2014 R Core Team
% Distributed under GPL 2 or later
\name{as.POSIX*}
\alias{as.POSIXct}
\alias{as.POSIXct.default}
\alias{as.POSIXct.POSIXlt}
\alias{as.POSIXct.date}
\alias{as.POSIXct.dates}
\alias{as.POSIXct.Date}
\alias{as.POSIXct.numeric}
\alias{as.POSIXlt}
\alias{as.POSIXlt.Date}
\alias{as.POSIXlt.date}
\alias{as.POSIXlt.dates}
\alias{as.POSIXlt.POSIXct}
\alias{as.POSIXlt.factor}
\alias{as.POSIXlt.character}
\alias{as.POSIXlt.default}
\alias{as.POSIXlt.numeric}
\alias{as.double.POSIXlt}
\title{Date-time Conversion Functions}
\description{
Functions to manipulate objects of classes \code{"POSIXlt"} and
\code{"POSIXct"} representing calendar dates and times.
}
\usage{
as.POSIXct(x, tz = "", \dots)
as.POSIXlt(x, tz = "", \dots)
\method{as.POSIXlt}{character}(x, tz = "", format, \dots)
\method{as.POSIXlt}{numeric}(x, tz = "", origin, \dots)
\method{as.double}{POSIXlt}(x, \dots)
}
\arguments{
\item{x}{An object to be converted.}
\item{tz}{A time zone specification to be used for the conversion,
\emph{if one is required}. System-specific (see \link{time zones}),
but \code{""} is the current time zone, and \code{"GMT"} is UTC
(Universal Time, Coordinated). Invalid values are most commonly
treated as UTC, on some platforms with a warning.}
\item{\dots}{further arguments to be passed to or from other methods.}
\item{format}{character string giving a date-time format as used
by \code{\link{strptime}}.}
\item{origin}{a date-time object, or something which can be coerced by
\code{as.POSIXct(tz = "GMT")} to such an object.}
}
\details{
The \code{as.POSIX*} functions convert an object to one of the two
classes used to represent date/times (calendar dates plus time to the
nearest second). They can convert a wide variety of objects,
including objects of the other class and of classes \code{"Date"},
\code{"date"} (from package \pkg{\link[date:as.date]{date}}),
\code{"chron"} and \code{"dates"} (from package
\pkg{\link[chron]{chron}}) to these classes. Dates without times are
treated as being at midnight UTC.
They can also convert character strings of the formats
\code{"2001-02-03"} and \code{"2001/02/03"} optionally followed by
white space and a time in the format \code{"14:52"} or
\code{"14:52:03"}. (Formats such as \code{"01/02/03"} are ambiguous
but can be converted via a format specification by
\code{\link{strptime}}.) Fractional seconds are allowed.
Alternatively, \code{format} can be specified for character vectors or
factors: if it is not specified and no standard format works for
all non-\code{NA} inputs an error is thrown.
If \code{format} is specified, remember that some of the format
specifications are locale-specific, and you may need to set the
\code{LC_TIME} category appropriately \emph{via}
\code{\link{Sys.setlocale}}. This most often affects the use of
\code{\%b}, \code{\%B} (month names) and \code{\%p} (AM/PM).
Logical \code{NA}s can be converted to either of the classes, but no
other logical vectors can be.
If you are given a numeric time as the number of seconds since an
epoch, see the examples.
Character input is first converted to class \code{"POSIXlt"} by
\code{\link{strptime}}: numeric input is first converted to
\code{"POSIXct"}. Any conversion that needs to go between the two
date-time classes requires a time zone: conversion from
\code{"POSIXlt"} to \code{"POSIXct"} will validate times in the
selected time zone. One issue is what happens at transitions
to and from DST, for example in the UK
\preformatted{as.POSIXct(strptime("2011-03-27 01:30:00", "\%Y-\%m-\%d \%H:\%M:\%S"))
as.POSIXct(strptime("2010-10-31 01:30:00", "\%Y-\%m-\%d \%H:\%M:\%S"))
}
are respectively invalid (the clocks went forward at 1:00 GMT to 2:00
BST) and ambiguous (the clocks went back at 2:00 BST to 1:00 GMT). What
happens in such cases is OS-specific: one should expect the first to
be \code{NA}, but the second could be interpreted as either BST or
GMT (and common OSes give both possible values). Note too (see
\code{\link{strftime}}) that OS facilities may not format invalid
times correctly.
}
\value{
\code{as.POSIXct} and \code{as.POSIXlt} return an object of the
appropriate class. If \code{tz} was specified, \code{as.POSIXlt}
will give an appropriate \code{"tzone"} attribute. Date-times known
to be invalid will be returned as \code{NA}.
}
\note{
Some of the concepts used have to be extended backwards in time (the
usage is said to be \sQuote{proleptic}). For example, the origin of
time for the \code{"POSIXct"} class, \sQuote{1970-01-01 00:00.00 UTC},
is before UTC was defined. More importantly, conversion is done
assuming the Gregorian calendar which was introduced in 1582 and not
used universally until the 20th century. One of the
re-interpretations assumed by ISO 8601:2004 is that there was a year
zero, even though current year numbering (and zero) is a much later
concept (525 AD for year numbers from 1 AD).
If you want to extract specific aspects of a time (such as the day of
the week) just convert it to class \code{"POSIXlt"} and extract the
relevant component(s) of the list, or if you want a character
representation (such as a named day of the week) use the
\code{\link[base:format.POSIXlt]{format}} method.
If a time zone is needed and that specified is invalid on your system,
what happens is system-specific but attempts to set it will probably
be ignored.
Conversion from character needs to find a suitable format unless one
is supplied (by trying common formats in turn): this can be slow for
long inputs.
}
\seealso{
\link{DateTimeClasses} for details of the classes;
\code{\link{strptime}} for conversion to and from character
representations.
\code{\link{Sys.timezone}} for details of the (system-specific) naming
of time zones.
\link{locales} for locale-specific aspects.
}
\examples{\donttest{
(z <- Sys.time()) # the current datetime, as class "POSIXct"
unclass(z) # a large integer
floor(unclass(z)/86400) # the number of days since 1970-01-01 (UTC)
(now <- as.POSIXlt(Sys.time())) # the current datetime, as class "POSIXlt"
unlist(unclass(now)) # a list shown as a named vector
now$year + 1900 # see ?DateTimeClasses
months(now); weekdays(now) # see ?months
## suppose we have a time in seconds since 1960-01-01 00:00:00 GMT
## (the origin used by SAS)
z <- 1472562988
# ways to convert this
as.POSIXct(z, origin = "1960-01-01") # local
as.POSIXct(z, origin = "1960-01-01", tz = "GMT") # in UTC
## SPSS dates (R-help 2006-02-16)
z <- c(10485849600, 10477641600, 10561104000, 10562745600)
as.Date(as.POSIXct(z, origin = "1582-10-14", tz = "GMT"))
## Stata date-times: milliseconds since 1960-01-01 00:00:00 GMT
## format %tc excludes leap-seconds, assumed here
## For format %tC including leap seconds, see foreign::read.dta()
z <- 1579598122120
op <- options(digits.secs = 3)
# avoid rounding down: milliseconds are not exactly representable
as.POSIXct((z+0.1)/1000, origin = "1960-01-01")
options(op)
## Matlab 'serial day number' (days and fractional days)
z <- 7.343736909722223e5 # 2010-08-23 16:35:00
as.POSIXct((z - 719529)*86400, origin = "1970-01-01", tz = "UTC")
as.POSIXlt(Sys.time(), "GMT") # the current time in UTC
}
\donttest{## These may not be correct names on your system
as.POSIXlt(Sys.time(), "America/New_York") # in New York
as.POSIXlt(Sys.time(), "EST5EDT") # alternative.
as.POSIXlt(Sys.time(), "EST" ) # somewhere in Eastern Canada
as.POSIXlt(Sys.time(), "HST") # in Hawaii
as.POSIXlt(Sys.time(), "Australia/Darwin")
}
#ifdef windows
cols <- c("code", "coordinates", "TZ", "comments")
tmp <- read.delim(file.path(R.home("share"), "zoneinfo", "zone.tab"),
header = FALSE, comment.char = "#", col.names = cols)
if(interactive()) View(tmp)
#endif
}
\keyword{utilities}
\keyword{chron}
| 8,145 |
gpl-2.0
|
cb43744778c64a30cecca818120fc889f0063547
|
aol-statsols/rm-char-create
|
man/rolemasterCharacterCreatorEnvironment.Rd
|
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/rolemasterCharacterCreatorEnvironment.R
\docType{package}
\name{rolemasterCharacterCreatorEnvironment}
\alias{rolemasterCharacterCreatorEnvironment}
\alias{rolemasterCharacterCreatorEnvironment-package}
\title{rolemasterCharacterCreatorEnvironment.}
\description{
rolemasterCharacterCreatorEnvironment.
}
| 393 |
gpl-2.0
|
63d0cb0c6d885871129fb61bffa9257883150b6c
|
mirror/r
|
src/library/base/man/as.POSIXlt.Rd
|
% File src/library/base/man/as.POSIXlt.Rd
% Part of the R package, http://www.R-project.org
% Copyright 1995-2014 R Core Team
% Distributed under GPL 2 or later
\name{as.POSIX*}
\alias{as.POSIXct}
\alias{as.POSIXct.default}
\alias{as.POSIXct.POSIXlt}
\alias{as.POSIXct.date}
\alias{as.POSIXct.dates}
\alias{as.POSIXct.Date}
\alias{as.POSIXct.numeric}
\alias{as.POSIXlt}
\alias{as.POSIXlt.Date}
\alias{as.POSIXlt.date}
\alias{as.POSIXlt.dates}
\alias{as.POSIXlt.POSIXct}
\alias{as.POSIXlt.factor}
\alias{as.POSIXlt.character}
\alias{as.POSIXlt.default}
\alias{as.POSIXlt.numeric}
\alias{as.double.POSIXlt}
\title{Date-time Conversion Functions}
\description{
Functions to manipulate objects of classes \code{"POSIXlt"} and
\code{"POSIXct"} representing calendar dates and times.
}
\usage{
as.POSIXct(x, tz = "", \dots)
as.POSIXlt(x, tz = "", \dots)
\method{as.POSIXlt}{character}(x, tz = "", format, \dots)
\method{as.POSIXlt}{numeric}(x, tz = "", origin, \dots)
\method{as.double}{POSIXlt}(x, \dots)
}
\arguments{
\item{x}{An object to be converted.}
\item{tz}{A time zone specification to be used for the conversion,
\emph{if one is required}. System-specific (see \link{time zones}),
but \code{""} is the current time zone, and \code{"GMT"} is UTC
(Universal Time, Coordinated). Invalid values are most commonly
treated as UTC, on some platforms with a warning.}
\item{\dots}{further arguments to be passed to or from other methods.}
\item{format}{character string giving a date-time format as used
by \code{\link{strptime}}.}
\item{origin}{a date-time object, or something which can be coerced by
\code{as.POSIXct(tz = "GMT")} to such an object.}
}
\details{
The \code{as.POSIX*} functions convert an object to one of the two
classes used to represent date/times (calendar dates plus time to the
nearest second). They can convert a wide variety of objects,
including objects of the other class and of classes \code{"Date"},
\code{"date"} (from package \pkg{\link[date:as.date]{date}}),
\code{"chron"} and \code{"dates"} (from package
\pkg{\link[chron]{chron}}) to these classes. Dates without times are
treated as being at midnight UTC.
They can also convert character strings of the formats
\code{"2001-02-03"} and \code{"2001/02/03"} optionally followed by
white space and a time in the format \code{"14:52"} or
\code{"14:52:03"}. (Formats such as \code{"01/02/03"} are ambiguous
but can be converted via a format specification by
\code{\link{strptime}}.) Fractional seconds are allowed.
Alternatively, \code{format} can be specified for character vectors or
factors: if it is not specified and no standard format works for
all non-\code{NA} inputs an error is thrown.
If \code{format} is specified, remember that some of the format
specifications are locale-specific, and you may need to set the
\code{LC_TIME} category appropriately \emph{via}
\code{\link{Sys.setlocale}}. This most often affects the use of
\code{\%b}, \code{\%B} (month names) and \code{\%p} (AM/PM).
Logical \code{NA}s can be converted to either of the classes, but no
other logical vectors can be.
If you are given a numeric time as the number of seconds since an
epoch, see the examples.
Character input is first converted to class \code{"POSIXlt"} by
\code{\link{strptime}}: numeric input is first converted to
\code{"POSIXct"}. Any conversion that needs to go between the two
date-time classes requires a time zone: conversion from
\code{"POSIXlt"} to \code{"POSIXct"} will validate times in the
selected time zone. One issue is what happens at transitions
to and from DST, for example in the UK
\preformatted{as.POSIXct(strptime("2011-03-27 01:30:00", "\%Y-\%m-\%d \%H:\%M:\%S"))
as.POSIXct(strptime("2010-10-31 01:30:00", "\%Y-\%m-\%d \%H:\%M:\%S"))
}
are respectively invalid (the clocks went forward at 1:00 GMT to 2:00
BST) and ambiguous (the clocks went back at 2:00 BST to 1:00 GMT). What
happens in such cases is OS-specific: one should expect the first to
be \code{NA}, but the second could be interpreted as either BST or
GMT (and common OSes give both possible values). Note too (see
\code{\link{strftime}}) that OS facilities may not format invalid
times correctly.
}
\value{
\code{as.POSIXct} and \code{as.POSIXlt} return an object of the
appropriate class. If \code{tz} was specified, \code{as.POSIXlt}
will give an appropriate \code{"tzone"} attribute. Date-times known
to be invalid will be returned as \code{NA}.
}
\note{
Some of the concepts used have to be extended backwards in time (the
usage is said to be \sQuote{proleptic}). For example, the origin of
time for the \code{"POSIXct"} class, \sQuote{1970-01-01 00:00.00 UTC},
is before UTC was defined. More importantly, conversion is done
assuming the Gregorian calendar which was introduced in 1582 and not
used universally until the 20th century. One of the
re-interpretations assumed by ISO 8601:2004 is that there was a year
zero, even though current year numbering (and zero) is a much later
concept (525 AD for year numbers from 1 AD).
If you want to extract specific aspects of a time (such as the day of
the week) just convert it to class \code{"POSIXlt"} and extract the
relevant component(s) of the list, or if you want a character
representation (such as a named day of the week) use the
\code{\link[base:format.POSIXlt]{format}} method.
If a time zone is needed and that specified is invalid on your system,
what happens is system-specific but attempts to set it will probably
be ignored.
Conversion from character needs to find a suitable format unless one
is supplied (by trying common formats in turn): this can be slow for
long inputs.
}
\seealso{
\link{DateTimeClasses} for details of the classes;
\code{\link{strptime}} for conversion to and from character
representations.
\code{\link{Sys.timezone}} for details of the (system-specific) naming
of time zones.
\link{locales} for locale-specific aspects.
}
\examples{\donttest{
(z <- Sys.time()) # the current datetime, as class "POSIXct"
unclass(z) # a large integer
floor(unclass(z)/86400) # the number of days since 1970-01-01 (UTC)
(now <- as.POSIXlt(Sys.time())) # the current datetime, as class "POSIXlt"
unlist(unclass(now)) # a list shown as a named vector
now$year + 1900 # see ?DateTimeClasses
months(now); weekdays(now) # see ?months
## suppose we have a time in seconds since 1960-01-01 00:00:00 GMT
## (the origin used by SAS)
z <- 1472562988
# ways to convert this
as.POSIXct(z, origin = "1960-01-01") # local
as.POSIXct(z, origin = "1960-01-01", tz = "GMT") # in UTC
## SPSS dates (R-help 2006-02-16)
z <- c(10485849600, 10477641600, 10561104000, 10562745600)
as.Date(as.POSIXct(z, origin = "1582-10-14", tz = "GMT"))
## Stata date-times: milliseconds since 1960-01-01 00:00:00 GMT
## format %tc excludes leap-seconds, assumed here
## For format %tC including leap seconds, see foreign::read.dta()
z <- 1579598122120
op <- options(digits.secs = 3)
# avoid rounding down: milliseconds are not exactly representable
as.POSIXct((z+0.1)/1000, origin = "1960-01-01")
options(op)
## Matlab 'serial day number' (days and fractional days)
z <- 7.343736909722223e5 # 2010-08-23 16:35:00
as.POSIXct((z - 719529)*86400, origin = "1970-01-01", tz = "UTC")
as.POSIXlt(Sys.time(), "GMT") # the current time in UTC
}
\donttest{## These may not be correct names on your system
as.POSIXlt(Sys.time(), "America/New_York") # in New York
as.POSIXlt(Sys.time(), "EST5EDT") # alternative.
as.POSIXlt(Sys.time(), "EST" ) # somewhere in Eastern Canada
as.POSIXlt(Sys.time(), "HST") # in Hawaii
as.POSIXlt(Sys.time(), "Australia/Darwin")
}
#ifdef windows
cols <- c("code", "coordinates", "TZ", "comments")
tmp <- read.delim(file.path(R.home("share"), "zoneinfo", "zone.tab"),
header = FALSE, comment.char = "#", col.names = cols)
if(interactive()) View(tmp)
#endif
}
\keyword{utilities}
\keyword{chron}
| 8,145 |
gpl-2.0
|
63d0cb0c6d885871129fb61bffa9257883150b6c
|
cmosetick/RRO
|
R-src/src/library/base/man/as.POSIXlt.Rd
|
% File src/library/base/man/as.POSIXlt.Rd
% Part of the R package, http://www.R-project.org
% Copyright 1995-2014 R Core Team
% Distributed under GPL 2 or later
\name{as.POSIX*}
\alias{as.POSIXct}
\alias{as.POSIXct.default}
\alias{as.POSIXct.POSIXlt}
\alias{as.POSIXct.date}
\alias{as.POSIXct.dates}
\alias{as.POSIXct.Date}
\alias{as.POSIXct.numeric}
\alias{as.POSIXlt}
\alias{as.POSIXlt.Date}
\alias{as.POSIXlt.date}
\alias{as.POSIXlt.dates}
\alias{as.POSIXlt.POSIXct}
\alias{as.POSIXlt.factor}
\alias{as.POSIXlt.character}
\alias{as.POSIXlt.default}
\alias{as.POSIXlt.numeric}
\alias{as.double.POSIXlt}
\title{Date-time Conversion Functions}
\description{
Functions to manipulate objects of classes \code{"POSIXlt"} and
\code{"POSIXct"} representing calendar dates and times.
}
\usage{
as.POSIXct(x, tz = "", \dots)
as.POSIXlt(x, tz = "", \dots)
\method{as.POSIXlt}{character}(x, tz = "", format, \dots)
\method{as.POSIXlt}{numeric}(x, tz = "", origin, \dots)
\method{as.double}{POSIXlt}(x, \dots)
}
\arguments{
\item{x}{An object to be converted.}
\item{tz}{A time zone specification to be used for the conversion,
\emph{if one is required}. System-specific (see \link{time zones}),
but \code{""} is the current time zone, and \code{"GMT"} is UTC
(Universal Time, Coordinated). Invalid values are most commonly
treated as UTC, on some platforms with a warning.}
\item{\dots}{further arguments to be passed to or from other methods.}
\item{format}{character string giving a date-time format as used
by \code{\link{strptime}}.}
\item{origin}{a date-time object, or something which can be coerced by
\code{as.POSIXct(tz = "GMT")} to such an object.}
}
\details{
The \code{as.POSIX*} functions convert an object to one of the two
classes used to represent date/times (calendar dates plus time to the
nearest second). They can convert a wide variety of objects,
including objects of the other class and of classes \code{"Date"},
\code{"date"} (from package \pkg{\link[date:as.date]{date}}),
\code{"chron"} and \code{"dates"} (from package
\pkg{\link[chron]{chron}}) to these classes. Dates without times are
treated as being at midnight UTC.
They can also convert character strings of the formats
\code{"2001-02-03"} and \code{"2001/02/03"} optionally followed by
white space and a time in the format \code{"14:52"} or
\code{"14:52:03"}. (Formats such as \code{"01/02/03"} are ambiguous
but can be converted via a format specification by
\code{\link{strptime}}.) Fractional seconds are allowed.
Alternatively, \code{format} can be specified for character vectors or
factors: if it is not specified and no standard format works for
all non-\code{NA} inputs an error is thrown.
If \code{format} is specified, remember that some of the format
specifications are locale-specific, and you may need to set the
\code{LC_TIME} category appropriately \emph{via}
\code{\link{Sys.setlocale}}. This most often affects the use of
\code{\%b}, \code{\%B} (month names) and \code{\%p} (AM/PM).
Logical \code{NA}s can be converted to either of the classes, but no
other logical vectors can be.
If you are given a numeric time as the number of seconds since an
epoch, see the examples.
Character input is first converted to class \code{"POSIXlt"} by
\code{\link{strptime}}: numeric input is first converted to
\code{"POSIXct"}. Any conversion that needs to go between the two
date-time classes requires a time zone: conversion from
\code{"POSIXlt"} to \code{"POSIXct"} will validate times in the
selected time zone. One issue is what happens at transitions
to and from DST, for example in the UK
\preformatted{as.POSIXct(strptime("2011-03-27 01:30:00", "\%Y-\%m-\%d \%H:\%M:\%S"))
as.POSIXct(strptime("2010-10-31 01:30:00", "\%Y-\%m-\%d \%H:\%M:\%S"))
}
are respectively invalid (the clocks went forward at 1:00 GMT to 2:00
BST) and ambiguous (the clocks went back at 2:00 BST to 1:00 GMT). What
happens in such cases is OS-specific: one should expect the first to
be \code{NA}, but the second could be interpreted as either BST or
GMT (and common OSes give both possible values). Note too (see
\code{\link{strftime}}) that OS facilities may not format invalid
times correctly.
}
\value{
\code{as.POSIXct} and \code{as.POSIXlt} return an object of the
appropriate class. If \code{tz} was specified, \code{as.POSIXlt}
will give an appropriate \code{"tzone"} attribute. Date-times known
to be invalid will be returned as \code{NA}.
}
\note{
Some of the concepts used have to be extended backwards in time (the
usage is said to be \sQuote{proleptic}). For example, the origin of
time for the \code{"POSIXct"} class, \sQuote{1970-01-01 00:00.00 UTC},
is before UTC was defined. More importantly, conversion is done
assuming the Gregorian calendar which was introduced in 1582 and not
used universally until the 20th century. One of the
re-interpretations assumed by ISO 8601:2004 is that there was a year
zero, even though current year numbering (and zero) is a much later
concept (525 AD for year numbers from 1 AD).
If you want to extract specific aspects of a time (such as the day of
the week) just convert it to class \code{"POSIXlt"} and extract the
relevant component(s) of the list, or if you want a character
representation (such as a named day of the week) use the
\code{\link[base:format.POSIXlt]{format}} method.
If a time zone is needed and that specified is invalid on your system,
what happens is system-specific but attempts to set it will probably
be ignored.
Conversion from character needs to find a suitable format unless one
is supplied (by trying common formats in turn): this can be slow for
long inputs.
}
\seealso{
\link{DateTimeClasses} for details of the classes;
\code{\link{strptime}} for conversion to and from character
representations.
\code{\link{Sys.timezone}} for details of the (system-specific) naming
of time zones.
\link{locales} for locale-specific aspects.
}
\examples{\donttest{
(z <- Sys.time()) # the current datetime, as class "POSIXct"
unclass(z) # a large integer
floor(unclass(z)/86400) # the number of days since 1970-01-01 (UTC)
(now <- as.POSIXlt(Sys.time())) # the current datetime, as class "POSIXlt"
unlist(unclass(now)) # a list shown as a named vector
now$year + 1900 # see ?DateTimeClasses
months(now); weekdays(now) # see ?months
## suppose we have a time in seconds since 1960-01-01 00:00:00 GMT
## (the origin used by SAS)
z <- 1472562988
# ways to convert this
as.POSIXct(z, origin = "1960-01-01") # local
as.POSIXct(z, origin = "1960-01-01", tz = "GMT") # in UTC
## SPSS dates (R-help 2006-02-16)
z <- c(10485849600, 10477641600, 10561104000, 10562745600)
as.Date(as.POSIXct(z, origin = "1582-10-14", tz = "GMT"))
## Stata date-times: milliseconds since 1960-01-01 00:00:00 GMT
## format %tc excludes leap-seconds, assumed here
## For format %tC including leap seconds, see foreign::read.dta()
z <- 1579598122120
op <- options(digits.secs = 3)
# avoid rounding down: milliseconds are not exactly representable
as.POSIXct((z+0.1)/1000, origin = "1960-01-01")
options(op)
## Matlab 'serial day number' (days and fractional days)
z <- 7.343736909722223e5 # 2010-08-23 16:35:00
as.POSIXct((z - 719529)*86400, origin = "1970-01-01", tz = "UTC")
as.POSIXlt(Sys.time(), "GMT") # the current time in UTC
}
\donttest{## These may not be correct names on your system
as.POSIXlt(Sys.time(), "America/New_York") # in New York
as.POSIXlt(Sys.time(), "EST5EDT") # alternative.
as.POSIXlt(Sys.time(), "EST" ) # somewhere in Eastern Canada
as.POSIXlt(Sys.time(), "HST") # in Hawaii
as.POSIXlt(Sys.time(), "Australia/Darwin")
}
#ifdef windows
cols <- c("code", "coordinates", "TZ", "comments")
tmp <- read.delim(file.path(R.home("share"), "zoneinfo", "zone.tab"),
header = FALSE, comment.char = "#", col.names = cols)
if(interactive()) View(tmp)
#endif
}
\keyword{utilities}
\keyword{chron}
| 8,145 |
gpl-2.0
|
5a4a06a9b425e44f756efc5699765d8b5353fe10
|
timelyportfolio/d3treeR
|
man/renderD3tree.Rd
|
% Generated by roxygen2 (4.1.1): do not edit by hand
% Please edit documentation in R/d3tree.R
\name{renderD3tree}
\alias{renderD3tree}
\title{Widget render function for use in Shiny}
\usage{
renderD3tree(expr, env = parent.frame(), quoted = FALSE)
}
\description{
Widget render function for use in Shiny
}
| 308 |
mit
|
daf9103c9648aa551e86015e567657071127391d
|
rettopnivek/utilityf
|
man/densityPoints.Rd
|
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/utility_functions.R
\name{densityPoints}
\alias{densityPoints}
\title{Estimate Density for Individual Observations}
\usage{
densityPoints(x, ...)
}
\arguments{
\item{x}{a numeric vector.}
\item{...}{additional parameters for the
\code{\link[stats]{density}} function.}
}
\value{
A list with...
\itemize{
\item x - the sorted values for the original input.
\item y - the associated empirical densities.
}
}
\description{
Given a vector of values, computes the empirical density
for each observation.
}
\examples{
plot(c(-4,4),c(0,.5),type='n',ylab='Density',xlab='z-scores')
x = rnorm( 100 )
dp = densityPoints( x )
points( dp$x, dp$y, pch = 19 )
}
| 740 |
mit
|
91ce5f41a096c8235cfd13e84b758e37d4f95c99
|
asardaes/dtwclust
|
man/compute_envelope.Rd
|
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/UTILS-compute-envelope.R
\name{compute_envelope}
\alias{compute_envelope}
\title{Time series warping envelopes}
\usage{
compute_envelope(x, window.size, error.check = TRUE)
}
\arguments{
\item{x}{A univariate time series.}
\item{window.size}{Window size for envelope calculation. See details.}
\item{error.check}{Logical indicating whether the function should try to detect inconsistencies
and give more informative errors messages. Also used internally to avoid repeating checks.}
}
\value{
A list with two elements (lower and upper envelopes respectively): \code{lower} and \code{upper}.
}
\description{
This function computes the envelopes for DTW lower bound calculations with a Sakoe-Chiba band for
a given univariate time series using the streaming algorithm proposed by Lemire (2009).
}
\details{
The windowing constraint uses a centered window. The calculations expect a value in
\code{window.size} that represents the distance between the point considered and one of the edges
of the window. Therefore, if, for example, \code{window.size = 10}, the warping for an
observation \eqn{x_i} considers the points between \eqn{x_{i-10}} and \eqn{x_{i+10}}, resulting
in \code{10(2) + 1 = 21} observations falling within the window.
}
\note{
This envelope is calculated assuming a Sakoe-Chiba constraint for DTW.
}
\examples{
data(uciCT)
H <- compute_envelope(CharTraj[[1L]], 18L)
matplot(do.call(cbind, H), type = "l", col = 2:3)
lines(CharTraj[[1L]])
}
\references{
Lemire D (2009). ``Faster retrieval with a two-pass dynamic-time-warping lower bound .'' \emph{Pattern
Recognition}, \strong{42}(9), pp. 2169 - 2180. ISSN 0031-3203,
\doi{10.1016/j.patcog.2008.11.030},
\url{https://www.sciencedirect.com/science/article/pii/S0031320308004925}.
}
| 1,832 |
gpl-3.0
|
10d30082ae52ac13f5048add9c1e199154caa158
|
UptakeOpenSource/uptasticsearch
|
r-pkg/man/unpack_nested_data.Rd
|
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/unpack_nested_data.R
\name{unpack_nested_data}
\alias{unpack_nested_data}
\title{Unpack a nested data.table}
\usage{
unpack_nested_data(chomped_df, col_to_unpack)
}
\arguments{
\item{chomped_df}{a data.table}
\item{col_to_unpack}{a character vector of length one: the column name to unpack}
}
\description{
After calling a \code{chomp_*} function or \code{es_search}, if
you had a nested array in the JSON, its corresponding column in the
resulting data.table is a data.frame itself (or a list of vectors). This
function expands that nested column out, adding its data to the original
data.table, and duplicating metadata down the rows as necessary.
This is a side-effect-free function: it returns a new data.table and the
input data.table is unmodified.
}
\examples{
# A sample raw result from a hits query:
result <- '[{"_source":{"timestamp":"2017-01-01","cust_name":"Austin","details":{
"cust_class":"big_spender","location":"chicago","pastPurchases":[{"film":"The Notebook",
"pmt_amount":6.25},{"film":"The Town","pmt_amount":8.00},{"film":"Zootopia","pmt_amount":7.50,
"matinee":true}]}}},{"_source":{"timestamp":"2017-02-02","cust_name":"James","details":{
"cust_class":"peasant","location":"chicago","pastPurchases":[{"film":"Minions",
"pmt_amount":6.25,"matinee":true},{"film":"Rogue One","pmt_amount":10.25},{"film":"Bridesmaids",
"pmt_amount":8.75},{"film":"Bridesmaids","pmt_amount":6.25,"matinee":true}]}}},{"_source":{
"timestamp":"2017-03-03","cust_name":"Nick","details":{"cust_class":"critic","location":"cannes",
"pastPurchases":[{"film":"Aala Kaf Ifrit","pmt_amount":0,"matinee":true},{
"film":"Dopo la guerra (Apres la Guerre)","pmt_amount":0,"matinee":true},{
"film":"Avengers: Infinity War","pmt_amount":12.75}]}}}]'
# Chomp into a data.table
sampleChompedDT <- chomp_hits(hits_json = result, keep_nested_data_cols = TRUE)
print(sampleChompedDT)
# (Note: use es_search() to get here in one step)
# Unpack by details.pastPurchases
unpackedDT <- unpack_nested_data(chomped_df = sampleChompedDT
, col_to_unpack = "details.pastPurchases")
print(unpackedDT)
}
| 2,271 |
bsd-3-clause
|
9f103344d3bb3688ee382ba0064a90c0ed5372d5
|
psathyrella/partis
|
packages/RPANDA/man/likelihood_subgroup_model.Rd
|
\name{likelihood_subgroup_model}
\alias{likelihood_subgroup_model}
\title{
Likelihood of a dataset under models with biogeography fit to a subgroup.
}
\description{
Computes the likelihood of a dataset under either the linear or exponential diversity dependent model with specified \code{sigma2} and slope values and with a \code{geography.object} formed using \code{\link{CreateGeoObject}}.
}
\usage{
likelihood_subgroup_model(data,phylo,geography.object,model=c("MC","DDexp","DDlin"),
par,return.z0=FALSE,maxN=NULL)
}
\arguments{
\item{phylo}{
an object of type 'phylo' (see ape documentation) produced as "map" from CreateGeobyClassObject. NB: the length of this object need not match number of items in data, since map may include tips outside of group with some part of their branch in the group
}
\item{data}{
a named vector of continuous data for a subgroup of interest with names corresponding to \code{phylo$tip.label}
}
\item{geography.object}{
a list of sympatry/group membership through time created using \code{\link{CreateGeobyClassObject}}
}
\item{model}{
model chosen to fit trait data, \code{"DDlin"} is the diversity-dependent linear model, and \code{"DDexp"} is the diversity-dependent exponential model of Weir & Mursleen 2013.
}
\item{par}{
a vector listing a value for \code{log(sig2)} (see Note) and either \code{b} (for the linear diversity dependent model) or \code{r} (for the exponential diversity dependent model), in that order.
}
\item{return.z0}{
logical indicating whether to return an estimate of the trait value at the root given the parameter values (if \code{TRUE}, function returns root value rather than negative log-likelihood)
}
\item{maxN}{
when fitting \code{DDlin} model, it is necessary to specify the maximum number of sympatric lineages to ensure that the rate returned does not correspond to negative sig2 values at any point in time (see Details).
}
}
\details{
When specifying \code{par}, \code{log(sig2)} (see Note) must be listed before the slope parameter (\code{b} or \code{r}).
maxN can be calculated using \code{maxN=max(vapply(geo.object$geography.object,function(x)max(rowSums(x)),1))}, where geo.object is the output of \code{\link{CreateGeoObject}}
}
\note{
To stabilize optimization, this function exponentiates the input \code{sig2} value, thus the user must input the log(sig2) value to compute the correct log likelihood (see example).
}
\value{
The negative log-likelihood value of the dataset (accordingly, the negative of the output should be recorded as the likelihood), given the phylogeny, \code{sig2} and slope values, and \code{geography.object}.
If \code{return.z0=TRUE}, the estimated root value for the par values is returned instead of the negative log-likelihood.
}
\references{
Drury, J., Clavel, J., Manceau, M., and Morlon, H. 2016. Estimating the effect of competition on trait evolution using maximum likelihood inference. \emph{Systematic Biology} doi 10.1093/sysbio/syw020
Weir, J. & Mursleen, S. 2012. Diversity-dependent cladogenesis and trait evolution in the adaptive radiation of the auks (Aves: Alcidae). \emph{Evolution} 67:403-416.
}
\author{Jonathan Drury \href{mailto:jonathan.p.drury@gmail.com}{jonathan.p.drury@gmail.com}
Julien Clavel
}
\seealso{
\code{\link{fit_t_comp}}
\code{\link{CreateGeoObject}}
\code{\link{likelihood_t_DD}}
}
\examples{
data(BGB.examples)
Canidae.phylo<-BGB.examples$Canidae.phylo
dummy.group<-c(rep("B",3),rep("A",12),rep("B",2),rep("A",6),rep("B",5),rep("A",6))
names(dummy.group)<-Canidae.phylo$tip.label
\donttest{
Canidae.simmap<-make.simmap(Canidae.phylo, dummy.group)
set.seed(123)
Canidae.data<-rnorm(length(Canidae.phylo$tip.label))
names(Canidae.data)<-Canidae.phylo$tip.label
Canidae.A<-Canidae.data[which(dummy.group=="A")]
Canidae.geobyclass.object<-CreateGeobyClassObject(phylo=Canidae.phylo,
simmap=Canidae.simmap, trim.class="A", ana.events=BGB.examples$Canidae.ana.events,
clado.events=BGB.examples$Canidae.clado.events,stratified=FALSE, rnd=5)
par <- c(log(0.01),-0.0005)
maxN<-max(vapply(Canidae.geobyclass.object$geography.object$geography.object,
function(x)max(rowSums(x)),1))
lh <- -likelihood_subgroup_model(data=Canidae.A, phylo=Canidae.geobyclass.object$map,
geo.object=Canidae.geobyclass.object$geography.object, model="DDlin", par=par,
return.z0=FALSE, maxN=maxN)
}
}
| 4,395 |
gpl-3.0
|
3fe402865ee0f60596e3abede3e2adca512a4651
|
jakob-r/mlrHyperopt
|
man/getParConfigParSet.Rd
|
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/ParConfig.R
\name{getParConfigParSet}
\alias{getParConfigParSet}
\title{Get the ParamSet of the configuration}
\usage{
getParConfigParSet(par.config, task = NULL)
}
\arguments{
\item{par.config}{[\code{\link{ParConfig}}]
The Parameter Configuration}
\item{task}{[\code{Task}]
The Task}
}
\value{
[\code{ParamSet}].
}
\description{
Get the \code{ParamSet} of the configuration. If a task is supplied the expressions will be evaluated.
}
\seealso{
Other ParConfig:
\code{\link{getParConfigLearnerClass}()},
\code{\link{getParConfigLearnerName}()},
\code{\link{getParConfigLearnerType}()},
\code{\link{getParConfigNote}()},
\code{\link{getParConfigParVals}()},
\code{\link{makeParConfig}()},
\code{\link{setParConfigLearnerType}()},
\code{\link{setParConfigLearner}()},
\code{\link{setParConfigNote}()},
\code{\link{setParConfigParSet}()},
\code{\link{setParConfigParVals}()}
}
\concept{ParConfig}
| 975 |
bsd-3-clause
|
01a6ee9199222aae258780edb9e3a5b77d1e6f83
|
agarbuno/ganalytics
|
man/gaDynSegment-class.Rd
|
% Generated by roxygen2 (4.1.1): do not edit by hand
% Please edit documentation in R/segment-classes.R
\docType{class}
\name{gaDynSegment-class}
\alias{gaDynSegment-class}
\title{`gaDynSegment` class.}
\description{
An S4 class to represent a list of scoped segment filter lists.
}
\keyword{internal}
| 303 |
mit
|
b485a70ceb3339b9132f4811f75c42e230708744
|
cxxr-devel/cxxr-svn-mirror
|
src/library/Recommended/nlme/man/lmeScale.Rd
|
% File nlme/man/lmeScale.Rd
% Part of the nlme package for R
% Distributed under GPL 2 or later: see nlme/LICENCE
\name{lmeScale}
\title{Scale for lme Optimization}
\usage{
lmeScale(start)
}
\alias{lmeScale}
\arguments{
\item{start}{the starting values for the coefficients to be estimated.}
}
\description{
This function calculates the scales to be used for each coefficient
estimated through an \code{nlm} optimization in the \code{lme}
function. If all initial values are zero, the scale is set to one for
all coefficients; else, the scale for a coefficient with non-zero
initial value is equal to the inverse of its initial value and the
scale for the coefficients with initial value equal to zero is set to
the median of the non-zero initial value coefficients.
}
\value{
a vector with the scales to be used in \code{nlm} for estimating the
coefficients.
}
\author{José Pinheiro and Douglas Bates \email{bates@stat.wisc.edu}}
\seealso{\code{\link{nlm}}}
\keyword{models}
| 999 |
gpl-2.0
|
77038aca73a78e2ba8f1e24b0cc17da683780629
|
FrissAnalytics/shinyJsTutorials
|
tutorials/materials3/C3/man/C3Gauge.Rd
|
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/C3Gauge.R
\name{C3Gauge}
\alias{C3Gauge}
\title{C3Gauge widget}
\usage{
C3Gauge(value, width = NULL, height = NULL)
}
\arguments{
\item{value}{value of gauge}
\item{width}{chart width}
\item{height}{chart height}
}
\description{
C3Gauge widget
}
| 327 |
mit
|
a3840cb191b28ce8deb386875729b9b909e0659a
|
bristolmathmodellers/biddmodellingcourse
|
man/summarise_model.Rd
|
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/summarise_model.R
\name{summarise_model}
\alias{summarise_model}
\title{Summarise a Model Simulation}
\usage{
summarise_model(sim)
}
\arguments{
\item{sim}{A tibble of model output as produced by
\code{\link[biddmodellingcourse]{solve_ode}}.}
}
\value{
A tibble of summary information for a model simulation.
}
\description{
Provides simple summary statistics for a model produced using
\code{\link[biddmodellingcourse]{solve_ode}}. These include the final population
sizes, the time and size of the maximum epidemic peak, and the duration of
the epidemic.
}
\examples{
## Intialise
N = 100000
I_0 = 1
S_0 = N - I_0
R_0 = 1.1
beta = R_0
##Time for model to run over
tbegin = 0
tend = 50
times <- seq(tbegin, tend, 1)
##Vectorise input
parameters <- as.matrix(c(beta = beta))
inits <- as.matrix(c(S = S_0, I = I_0))
sim <- solve_ode(model = SI_ode, inits, parameters, times, as.data.frame = TRUE)
summarise_model(sim)
}
| 1,002 |
gpl-3.0
|
290bfd6b6cb6a46b2162547ec4e74af1cb8e074c
|
smu/smumisc
|
man/SeasonalMean.Rd
|
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/SeasonalMean.R
\name{SeasonalMean}
\alias{SeasonalMean}
\title{Calculate seasonal means from data.table}
\usage{
SeasonalMean(data, season, variable = "value", na.rm = FALSE)
}
\arguments{
\item{data}{data table containing the columns date (Date object) and value (the variable)}
\item{season}{string descripting the season to average, e.g., 'DJF'}
\item{na.rm}{a logical value indicating whether 'NA' values should be
stripped before the computation proceeds.}
}
\value{
data table with seasonal averaged values.
}
\description{
Calculate seasonal means from data.table
}
\examples{
mydata <- data.frame(date = seq.Date(as.Date('1990-01-01'),
as.Date('2000-12-31'),
by = '1 months'),
value = rnorm(11*12))
SeasonalMean(mydata, 'DJF')
SeasonalMean(mydata, 'DJFMAM')
}
| 952 |
gpl-2.0
|
8ee6b74ad936891199bdd8afae435b3010e7ef4c
|
Albluca/rRoma
|
man/PlotSampleProjections.Rd
|
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/Plotting.R
\name{PlotSampleProjections}
\alias{PlotSampleProjections}
\title{Plot sample score across selected samples}
\usage{
PlotSampleProjections(RomaData, PlotSamples = 40, ExpressionMatrix = NULL,
LogExpression = TRUE, Selected = NULL)
}
\arguments{
\item{RomaData}{list, the analysis returned by rRoma}
\item{PlotSamples}{scalar, numeric. The number of samples to plot}
\item{ExpressionMatrix}{matrix, numeric. The expression matrix used to produce gene expression boxplot. If NULL (default), no gene expression information is reported}
\item{LogExpression}{boolean, should gene expression be logtransformed?}
\item{Selected}{vector, integer. The position of the genesets to plot}
}
\description{
Plot sample score across selected samples
}
| 832 |
gpl-3.0
|
fab5ec564e75e88773cb268f6bb1d6e7534b1c71
|
KopfLab/isoreader
|
man/iso_printing.Rd
|
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/isodata_structures.R
\name{print.iso_file_list}
\alias{print.iso_file_list}
\alias{print.iso_file}
\alias{print.dual_inlet}
\alias{print.continuous_flow}
\alias{print.scan}
\title{Isofile printing}
\usage{
\method{print}{iso_file_list}(x, ...)
\method{print}{iso_file}(x, ..., show_problems = TRUE)
\method{print}{dual_inlet}(x, ..., show_problems = TRUE)
\method{print}{continuous_flow}(x, ..., show_problems = TRUE)
\method{print}{scan}(x, ..., show_problems = TRUE)
}
\arguments{
\item{x}{Object to show.}
\item{...}{additional parameters passed to print.default}
\item{show_problems}{whether to show encountered problems}
}
\description{
Print summary of individual iso_files (dual inlet or continuous flow) or collection of iso_files.
}
| 826 |
gpl-2.0
|
a21a8abb6268e2740a32d6f5b4d0285289bffdef
|
snurk/meta-strains
|
Clomial_meta/man/Clomial.generate.data.Rd
|
\name{Clomial.generate.data}
\alias{Clomial.generate.data}
\title{
Generates simulated data to test performance of Clomial algorithm.
}
\description{
Data sets are simulated based on binomial distribution using
random parameters for the model. The accuracy of the EM procedure
can be estimated by comparing the inferred parameters vs. the known
ones which were used to generate the data.
}
\usage{
Clomial.generate.data(N, C, S, averageCoverage, mutFraction,
doSample1Normal = FALSE,erroRate=0,doCheckDc=TRUE)
}
\arguments{
\item{N}{
The number of genomic loci.
}
\item{C}{
The number of clones.
}
\item{S}{
The number of samples.
}
\item{averageCoverage}{
The average coverage over each loci, each sample.
}
\item{mutFraction}{
Should be in range 0-1. Each loci in every sample can be mutated
with this probability.
}
\item{doSample1Normal}{
If TRUE, no contamination with the tumor content is allowed for
the normal sample. I.e. the first column of the generated \code{P}
matrix will start with 1, and the rest of its entries will be equal to 0.
}
\item{erroRate}{
The sequencing noise can be simulated by assigning a positive value
to this parameter, which is the probability of reading a normal
allele as the alternative allele, and vica versa.
}
\item{doCheckDc}{
If TRUE, generating with be repeated until no row of Dc is all zeros to guarantee
all loci have positive coverage in at least one sample.
}
}
\details{
See the reference below for details.
}
\value{
A list will be made with the following entries:
\item{Dc }{A matrix of simulated coverage for all loci and samples.}
\item{Dt }{A matrix of alternative allele counts for all loci
and samples.}
\item{Ptrue }{The true clone frequency matrix used for
generating the data.}
\item{U }{The true genotype matrix used for generating the data.}
\item{Likelihood }{The log-likelihood of the model with the
true parameters.}
\item{Phi}{The matrix of the second parameters of the binomial
distributions; each entry is the probability that a read
contains the variant allele at a locus in a sample.}
}
\references{
Inferring clonal composition from multiple sections of a breast cancer,
Zare et al., Submitted.
}
\author{
Habil Zare
}
\seealso{
\code{\link[Clomial:Clomial-package]{Clomial}},
\code{\link{Clomial.likelihood}}
}
\examples{
set.seed(1)
simulated <- Clomial.generate.data(N=20, C=4, S=10,
averageCoverage=1000, mutFraction=0.1)
simulated$Dc
}
\keyword{ documentation }
\keyword{ models }
| 2,558 |
mit
|
ec3bdb9dcb4f9252f21dfcba4831338ef4d2bcee
|
charles-plessy/smallCAGEqc
|
man/chrFreqs.Rd
|
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/chrFreqs.R
\name{chrFreqs}
\alias{chrFreqs}
\title{chrFreqs}
\usage{
chrFreqs(gr, chrs)
}
\arguments{
\item{gr}{A GenomicRanges object.}
\item{chrs}{A character vector of chromosome names.}
}
\value{
A named character vector indicating the number of feature
counts per chromosome in a GenomicRanges object. This is done by
running GRanges' seqnames() function, converting the output to a
table, and converting the table to a named character vector, according
to the names passed to the function. This is useful to create a
matrix or a data frame from a list of genomic ranges.
}
\description{
Count features per chromosome
}
\examples{
if(require(rtracklayer, quietly = TRUE)) {
gr <- system.file("extdata", "BED12_A.bed", package="smallCAGEqc") \%>\%
rtracklayer::import.bed
chrFreqs(gr, c("chr1", "chr2", "chrX", "chrY", "chrZ"))
}
}
| 932 |
cc0-1.0
|
89e5785090700756e7694b63048957a3832be834
|
danielcanueto/rDolphin
|
man/write_plots.Rd
|
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/write_plots.R
\name{write_plots}
\alias{write_plots}
\title{Import of variables stored in the parameters file and of the dataset to quantify}
\usage{
write_plots(export_path, final_output, reproducibility_data,
signals_to_plot = NA)
}
\arguments{
\item{export_path}{Path where plots are stored inside a created 'plots' folder}
\item{final_output}{List with quantifications and indicators of quality of quantification.}
\item{reproducibility_data}{List with necessary information to load quantifications on the Shiny GUI.}
\item{signals_to_plot}{Vector of indexes of signals in ROI data to plot. By default, NA and all figures are outputted.}
}
\value{
Plots in pdf files
}
\description{
Import of variables stored in the parameters file and of the dataset to quantify
}
\examples{
setwd(paste(system.file(package = "rDolphin"),"extdata",sep='/'))
load("MTBLS242_subset_profiling_data.RData")
#Not run:
#write_plots('',profiling_data$final_output,profiling_data$reproducibility_data)
}
| 1,068 |
gpl-2.0
|
de1b387281eed7e18d3afa580635688236ec123e
|
cran/Zelig
|
man/mexico.Rd
|
\name{mexico}
\alias{mexico}
\title{Voting Data from the 1988 Mexican Presidental Election}
\description{
This dataset contains voting data for the 1988 Mexican presidential
election.
}
\usage{data(mexico)}
\format{A table containing 33 variables and 1,359 observations.}
\source{ICPSR}
\references{
King, Gary, Michael Tomz and Jason Wittenberg (2000).
``Making the Most of Statistical Analyses: Improving Interpretation and
Presentation,'' \emph{American Journal of Political Science}, vol. 44,
pp. 341-355.
King, Tomz and Wittenberg. ICPSR Publication Related Archive, 1255.
}
\keyword{datasets}
| 629 |
gpl-2.0
|
b29d5cc31326cc6deb17767ba48ff12b63d89712
|
IQSS/Zelig4
|
man/getResponseTerms.list.Rd
|
\name{getResponseTerms.list}
\alias{getResponseTerms.list}
\title{Get Response Terms from a List-style Formula}
\usage{
\method{getResponseTerms}{list}(x, ...)
}
\arguments{
\item{x}{a list of formulae}
\item{...}{ignored parameters}
}
\value{
a character-vector specifying the response terms of the
formula
}
\description{
This method gets the response terms from a standard
formula
}
\author{
Matt Owen
}
| 425 |
gpl-2.0
|
de1b387281eed7e18d3afa580635688236ec123e
|
IQSS/Zelig4
|
man/mexico.Rd
|
\name{mexico}
\alias{mexico}
\title{Voting Data from the 1988 Mexican Presidental Election}
\description{
This dataset contains voting data for the 1988 Mexican presidential
election.
}
\usage{data(mexico)}
\format{A table containing 33 variables and 1,359 observations.}
\source{ICPSR}
\references{
King, Gary, Michael Tomz and Jason Wittenberg (2000).
``Making the Most of Statistical Analyses: Improving Interpretation and
Presentation,'' \emph{American Journal of Political Science}, vol. 44,
pp. 341-355.
King, Tomz and Wittenberg. ICPSR Publication Related Archive, 1255.
}
\keyword{datasets}
| 629 |
gpl-2.0
|
6101035e9026710afd80f4d7b1eab1e802e443a5
|
gdlc/BGLR-R
|
man/summary.BGLR.Rd
|
\name{summary.BGLR}
\alias{summary.BGLR}
\title{summary for BGLR fitted models}
\description{
Gives a summary for a fitted model using BGLR function.
}
\usage{
\method{summary}{BGLR}(object, ...)
}
\arguments{
\item{object}{An object of class \code{BGLR}.}
\item{...}{Further arguments passed to or from other methods.}
}
\author{
Gustavo de los Campos, Paulino Perez Rodriguez,
}
\seealso{
\code{BGLR}.
}
\examples{
\dontrun{
setwd(tempdir())
library(BGLR)
data(wheat)
out=BLR(y=wheat.Y[,1],XL=wheat.X)
summary(out)
}
}
\keyword{summary}
| 555 |
gpl-3.0
|
6101035e9026710afd80f4d7b1eab1e802e443a5
|
cran/BGLR
|
man/summary.BGLR.Rd
|
\name{summary.BGLR}
\alias{summary.BGLR}
\title{summary for BGLR fitted models}
\description{
Gives a summary for a fitted model using BGLR function.
}
\usage{
\method{summary}{BGLR}(object, ...)
}
\arguments{
\item{object}{An object of class \code{BGLR}.}
\item{...}{Further arguments passed to or from other methods.}
}
\author{
Gustavo de los Campos, Paulino Perez Rodriguez,
}
\seealso{
\code{BGLR}.
}
\examples{
\dontrun{
setwd(tempdir())
library(BGLR)
data(wheat)
out=BLR(y=wheat.Y[,1],XL=wheat.X)
summary(out)
}
}
\keyword{summary}
| 555 |
gpl-3.0
|
c6d6da8f6ea4656c6e5a3ffe535a48d5f6275955
|
jeroenooms/r-source
|
src/library/base/man/NA.Rd
|
% File src/library/base/man/NA.Rd
% Part of the R package, https://www.R-project.org
% Copyright 1995-2018 R Core Team
% Distributed under GPL 2 or later
\name{NA}
\alias{NA}
\alias{NA_integer_}
\alias{NA_real_}
\alias{NA_complex_}
\alias{NA_character_}
\alias{is.na}
\alias{is.na.data.frame}
\alias{is.na<-}
\alias{is.na<-.default}
\alias{anyNA}
\alias{anyNA.data.frame}
\alias{anyMissing}% an alternative name (in Biobase and S+ as of ~2006)
\title{\sQuote{Not Available} / Missing Values}
\description{
\code{NA} is a logical constant of length 1 which contains a missing
value indicator. \code{NA} can be coerced to any other vector
type except raw. There are also constants \code{NA_integer_},
\code{NA_real_}, \code{NA_complex_} and \code{NA_character_} of the
other atomic vector types which support missing values: all of these
are \link{reserved} words in the \R language.
The generic function \code{is.na} indicates which elements are missing.
The generic function \code{is.na<-} sets elements to \code{NA}.
The generic function \code{anyNA} implements \code{any(is.na(x))} in a
possibly faster way (especially for atomic vectors).
}
\usage{
NA
is.na(x)
anyNA(x, recursive = FALSE)
\method{is.na}{data.frame}(x)
is.na(x) <- value
}
\arguments{
\item{x}{an \R object to be tested: the default method for
\code{is.na} and \code{anyNA} handle atomic vectors, lists,
pairlists, and \code{NULL}.}
\item{recursive}{logical: should \code{anyNA} be applied recursively
to lists and pairlists?}
\item{value}{a suitable index vector for use with \code{x}.}
}
\details{
The \code{NA} of character type is distinct from the string
\code{"NA"}. Programmers who need to specify an explicit missing
string should use \code{NA_character_} (rather than \code{"NA"}) or set
elements to \code{NA} using \code{is.na<-}.
\code{is.na} and \code{anyNA} are generic: you can write
methods to handle specific classes of objects, see
\link{InternalMethods}.
Function \code{is.na<-} may provide a safer way to set missingness.
It behaves differently for factors, for example.
Numerical computations using \code{NA} will normally result in
\code{NA}: a possible exception is where \code{\link{NaN}} is also
involved, in which case either might result (which may depend on
the \R platform). Logical computations treat \code{NA} as a missing
\code{TRUE/FALSE} value, and so may return \code{TRUE} or \code{FALSE}
if the expression does not depend on the \code{NA} operand.
The default method for \code{anyNA} handles atomic vectors without a
class and \code{NULL}. It calls \code{any(is.na(x))} on objects with
classes and for \code{recursive = FALSE}, on lists and pairlists.
}
\value{
The default method for \code{is.na} applied to an atomic vector
returns a logical vector of the same length as its argument \code{x},
containing \code{TRUE} for those elements marked \code{NA} or, for
numeric or complex vectors, \code{\link{NaN}}, and \code{FALSE}
otherwise. (A complex value is regarded as \code{NA} if either its
real or imaginary part is \code{NA} or \code{\link{NaN}}.)
\code{dim}, \code{dimnames} and \code{names} attributes are copied to
the result.
The default methods also work for lists and pairlists:\cr
For \code{is.na}, elementwise the result is false unless that element
is a length-one atomic vector and the single element of that vector is
regarded as \code{NA} or \code{NaN} (note that any \code{is.na}
method for the class of the element is ignored).\cr
\code{anyNA(recursive = FALSE)} works the same way as \code{is.na};
\code{anyNA(recursive = TRUE)} applies \code{anyNA} (with method
dispatch) to each element.
The data frame method for \code{is.na} returns a logical matrix
with the same dimensions as the data frame, and with dimnames taken
from the row and column names of the data frame.
\code{anyNA(NULL)} is false; \code{is.na(NULL)} is \code{logical(0)}
(no longer warning since \R version 3.5.0).
}
\references{
Becker, R. A., Chambers, J. M. and Wilks, A. R. (1988)
\emph{The New S Language}.
Wadsworth & Brooks/Cole.
Chambers, J. M. (1998)
\emph{Programming with Data. A Guide to the S Language}.
Springer.
}
\seealso{
\code{\link{NaN}}, \code{\link{is.nan}}, etc.,
and the utility function \code{\link{complete.cases}}.
\code{\link{na.action}}, \code{\link{na.omit}}, \code{\link{na.fail}}
on how methods can be tuned to deal with missing values.
}
\examples{
is.na(c(1, NA)) #> FALSE TRUE
is.na(paste(c(1, NA))) #> FALSE FALSE
(xx <- c(0:4))
is.na(xx) <- c(2, 4)
xx #> 0 NA 2 NA 4
anyNA(xx) # TRUE
# Some logical operations do not return NA
c(TRUE, FALSE) & NA
c(TRUE, FALSE) | NA
\donttest{
## Measure speed difference in a favourable case:
## the difference depends on the platform, on most ca 3x.
x <- 1:10000; x[5000] <- NaN # coerces x to be double
if(require("microbenchmark")) { # does not work reliably on all platforms
print(microbenchmark(any(is.na(x)), anyNA(x)))
} else {
nSim <- 2^13
print(rbind(is.na = system.time(replicate(nSim, any(is.na(x)))),
anyNA = system.time(replicate(nSim, anyNA(x)))))
}
}
## anyNA() can work recursively with list()s:
LL <- list(1:5, c(NA, 5:8), c("A","NA"), c("a", NA_character_))
L2 <- LL[c(1,3)]
sapply(LL, anyNA); c(anyNA(LL), anyNA(LL, TRUE))
sapply(L2, anyNA); c(anyNA(L2), anyNA(L2, TRUE))
## ... lists, and hence data frames, too:
dN <- dd <- USJudgeRatings; dN[3,6] <- NA
anyNA(dd) # FALSE
anyNA(dN) # TRUE
}
\keyword{NA}
\keyword{logic}
\keyword{manip}
| 5,636 |
gpl-2.0
|
a03f7feee03771e0fa27991a0c6421b61739acf2
|
harvestchoice/hc-api3
|
man/genCartoCSS.Rd
|
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/indicator.R
\name{genCartoCSS}
\alias{genCartoCSS}
\title{Generate CartoCSS snippet to symbolize raster tiles}
\usage{
genCartoCSS(var, pal = "BuGn", legend = TRUE, ...)
}
\arguments{
\item{var}{character arry of HarvestChoice indicator code(s)}
\item{pal}{optional Brewer color palette name used for plotting}
\item{legend}{if TRUE returns HarvestChoice legend, otherwise returns default legend}
\item{...}{any argument passed to \code{\link{getLayer}}, e.g.
\code{by="FS_2012"}}
\item{iso3}{optional country or region filter (3-letter code)}
}
\value{
character array of CartoCSS snippet for indicator(s) \code{var}
}
\description{
Helper function to generate CartoCSS rules for processing rasters using Mapnik
}
\examples{
# CartoCSS for soil organic carbon and cassava value of production
genCartoCSS(c("soc_d5", "cass_v"))
}
| 913 |
gpl-3.0
|
781c0f85eab4cbecb94d8e396916c2c429798470
|
githubfun/portfolioeffect-quant-r
|
PortfolioEffectHFT/man/optimization_info.Rd
|
\name{optimization_info}
\alias{optimization_info}
\title{Porfolio Optimization - Print Optimization Details}
\usage{optimization_info(portfolio)
}
\arguments{
\item{portfolio}{Portfolio object returned by \link[=optimization_run]{optimization_run( )} function}
}
\description{Prints optimization details (constraint violations, local optima and etc.) for an optimal portfolio.}
\value{
Prints summary table.
}
\author{Kostin Andrey <andrey.kostin@portfolioeffect.com>}
\examples{
\dontrun{
dateStart = "2014-11-17 09:30:00"
dateEnd = "2014-11-17 16:00:00"
# create portfolio
portfolio=portfolio_create(dateStart,dateEnd)
portfolio_settings(portfolio,portfolioMetricsMode="price",windowLength = "3600s",
resultsSamplingInterval="60s")
portfolio_addPosition(portfolio,'AAPL',100)
portfolio_addPosition(portfolio,'C',300)
# set optimization goals and constraints
optimizer=optimization_goal(portfolio,"Return","maximize")
optimizer=optimization_constraint_beta(optimizer,"<=",0.5)
# run optimization and print optimization details
optimalPortfolio=optimization_run(optimizer)
optimization_info(optimalPortfolio)
}}
\keyword{PortfolioEffectHFT}
\keyword{optimization_info}
| 1,212 |
bsd-2-clause
|
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.