Commit 9be895d4 authored by Enrico Schumann's avatar Enrico Schumann

Make small fixes in Rd sources

parent 123aa8e6
......@@ -5,7 +5,7 @@
}
\description{
Read time-series data from files and merge them.
Read time-series data from files and merge them.
}
\usage{
......@@ -38,20 +38,20 @@ read_ts_tables(file, dir, t.type = "guess",
character.
}
\item{return.class}{
\code{NULL} (default) or character: if \code{NULL}, a list is
returned. Also supported are \code{zoo},
\code{\link{data.frame}} and \code{\link{ts_table}}.
}
\item{drop.weekends}{
logical
}
\item{column.names}{
character: a format string for column names; may contain
\code{\%dir\%}, \code{\%file\%}, and \code{\%column\%}
}
\item{backend}{
character: currently, only \sQuote{\code{csv}} is fully supported
......@@ -62,10 +62,10 @@ read_ts_tables(file, dir, t.type = "guess",
from package \pkg{data.table}
}
\item{frequency}{
character: only used when \code{t.type} is
\code{POSIXct} (or guessed to be \code{POSIXct})
}
}
\details{
......@@ -103,5 +103,4 @@ read_ts_tables(c("t1", "t2"),
dir = d, columns = "A",
return.class = "zoo",
column.names = "\%file\%.\%column\%")
}
......@@ -38,7 +38,7 @@ ts_table(data, timestamp, columns)
\item{columns}{a character vector that provides the
columns names}
}
There may be other attributes as well, but these three
are always present.
......@@ -56,8 +56,6 @@ ts_table(data, timestamp, columns)
vector to an actual timestamp. For this, they may use
the function \code{\link{ttime}} (\sQuote{translate time}).
}
\value{
a \code{ts_table}
......
......@@ -31,7 +31,7 @@
\code{\link{read_ts_tables}} for storing and loading a
\code{\link{ts_table}} (or several).
See the tutorial at
For getting started, see the tutorial at
\url{https://gitlab.com/enricoschumann/tsdb/blob/master/README.org}
or
\url{https://github.com/enricoschumann/tsdb/blob/master/README.org} .
......
......@@ -22,22 +22,22 @@ write_ts_table(ts, dir, file, add = FALSE, overwrite = FALSE,
character
}
\item{add}{
logical: if \code{TRUE}, add data with timestamps
that are not in a file.
}
\item{overwrite}{
logical: overwrite existing file when data
differs. \code{overwrite} implies \code{add}.
}
\item{replace.file}{
logical: if \code{TRUE}, an existing file is deleted
and replaced by a new file (i.e. containing \code{ts})
}
\item{backend}{
......@@ -45,7 +45,7 @@ write_ts_table(ts, dir, file, add = FALSE, overwrite = FALSE,
are supported
}
}
\details{
......@@ -68,7 +68,6 @@ write_ts_table(ts, dir, file, add = FALSE, overwrite = FALSE,
no data will be removed from the file: timestamps not
in \code{ts} remain unchanged in the file.
}
\value{
Invisibly, the number of data rows written to a file.
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment