aboutsummaryrefslogtreecommitdiff
path: root/man/Extract.mmkin.Rd
diff options
context:
space:
mode:
authorJohannes Ranke <jranke@uni-bremen.de>2019-10-25 00:37:42 +0200
committerJohannes Ranke <jranke@uni-bremen.de>2019-10-25 02:03:54 +0200
commit0a3eb0893cb4bd1b12f07a79069d1c7f5e991495 (patch)
tree1bf0ffeb710b3438fee224d0a657606b4c36b495 /man/Extract.mmkin.Rd
parent053bf27d3f265c7a7378e2df3e00cf891e0d1bb2 (diff)
Use roxygen for functions and methods
Diffstat (limited to 'man/Extract.mmkin.Rd')
-rw-r--r--man/Extract.mmkin.Rd22
1 files changed, 13 insertions, 9 deletions
diff --git a/man/Extract.mmkin.Rd b/man/Extract.mmkin.Rd
index 973dc28f..7677bdba 100644
--- a/man/Extract.mmkin.Rd
+++ b/man/Extract.mmkin.Rd
@@ -1,12 +1,11 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/mmkin.R
\name{[.mmkin}
\alias{[.mmkin}
\title{Subsetting method for mmkin objects}
\usage{
\method{[}{mmkin}(x, i, j, ..., drop = FALSE)
}
-\description{
- Subsetting method for mmkin objects.
-}
\arguments{
\item{x}{An \code{\link{mmkin} object}}
@@ -16,16 +15,17 @@
\item{...}{Not used, only there to satisfy the generic method definition}
-\item{drop}{If FALSE, the method always returns an mmkin object, otherwise either
- a list of mkinfit objects or a single mkinfit object.}
+\item{drop}{If FALSE, the method always returns an mmkin object, otherwise
+either a list of mkinfit objects or a single mkinfit object.}
}
\value{
- An object of class \code{\link{mmkin}}.
+An object of class \code{\link{mmkin}}.
}
-\author{
- Johannes Ranke
+\description{
+Subsetting method for mmkin objects.
}
\examples{
+
# Only use one core, to pass R CMD check --as-cran
fits <- mmkin(c("SFO", "FOMC"), list(B = FOCUS_2006_B, C = FOCUS_2006_C),
cores = 1, quiet = TRUE)
@@ -35,6 +35,10 @@
head(
# This extracts an mkinfit object with lots of components
- fits[["FOMC", "B"]]
+ fits[["FOMC", "B"]]
)
+
+}
+\author{
+Johannes Ranke
}

Contact - Imprint