Commit 2c26e3ad authored by Enrico Schumann's avatar Enrico Schumann

Update docs, NEWS

parent 36fd35ab
......@@ -3,3 +3,9 @@ README.html
README.pdf
test_results.txt
README.bbl
README-blx.bib
README.ilg
README.ind
README.tex
\ No newline at end of file
......@@ -3,6 +3,9 @@ v0.4-0 (2017-02-06)
o 'read_ts_tables' has a new argument 'column.name',
which specifies the format of column names in results
o there is a piblic repository at
https://gitlab.com/enricoschumann/tsdb
v0.3-0 (2016-12-10)
o 'write_ts_table' has a new argument 'add': If TRUE,
......
......@@ -111,6 +111,32 @@
options(useFancyQuotes=FALSE)
#+END_SRC
* About tsdb
A terribly-simple data base for time series. All series
are saved as csv files. The package offers utilities
for saving files in a standardised format, and for
retrieving and joining data.
** Good things about tsdb
- no setup needed, no system dependencies
(i.e. external software, such as a database)
- completely portable; moving from one computer to
another requires no effort (the only file to take
care of is file encoding)
- data usable by other software
** When you need another database
- tsdb is potentially slow
- no multi-user support; no access-rights management
(other than that provided by the OS)
- no network protocols
* Using tsdb
** Writing data
......@@ -439,26 +465,3 @@ the order of the timestamps in a shell such as =bash=.
:END:
* About tsdb
A terribly-simple data base for time series. All series
are saved as csv files. The package offers utilities
for saving files in a standardised format, and for
retrieving and joining data.
** Good things
- no setup needed, no system dependencies
(i.e. external software, such as a database)
- completely portable [TODO mention encoding of
headers]; moving from one computer to another no
effort
- data usable by other software
** When you need another database
- tsdb is potentially slow
- no multi-user support; no access-rights management
(other than that provided by the OS)
- no network protocols
......@@ -10,7 +10,8 @@
read_ts_tables(file, dir, t.type = "guess",
start, end, columns,
return.class = NULL,
drop.weekends = TRUE)
drop.weekends = TRUE,
column.name = "\%dir\%/\%file\%::\%column\%")
}
\arguments{
\item{file}{
......@@ -37,9 +38,15 @@ read_ts_tables(file, dir, t.type = "guess",
\item{drop.weekends}{
logical
}
\item{column.name}{
character: a format string for column names; may contain
\code{\%dir\%}, \code{\%file\%}, and \code{\%column\%}
}
}
\details{
Read files.
Read time-series data from csv files.
}
\value{
When return.class is \code{NULL}, a list:
......
%% \VignetteIndexEntry{Overview of the tsdb package}
\documentclass[a4paper,11pt]{article}
\usepackage[left = 3cm, top = 2cm, bottom = 2cm, right = 4cm]{geometry}
\usepackage[noae,nogin]{Sweave}
\usepackage{libertine}
\usepackage[scaled=0.8]{DejaVuSansMono}
\usepackage[T1]{fontenc}
\renewcommand*\familydefault{\sfdefault}
\usepackage{amsmath,amstext}
\usepackage{hyperref}
\usepackage{natbib}
\usepackage{xcolor}
\usepackage{framed}
\usepackage[hang]{footmisc}
\definecolor{grau2}{rgb}{.2,.2,.2}
\definecolor{grau7}{rgb}{.7,.7,.7}
\DefineVerbatimEnvironment{Sinput}{Verbatim}{}
\DefineVerbatimEnvironment{Soutput}{Verbatim}{frame=single,
xleftmargin=0em, formatcom=\color{grau2},rulecolor=\color{grau7}}
\DefineVerbatimEnvironment{Scode}{Verbatim}{xleftmargin=2em}
\fvset{listparameters={\setlength{\topsep}{0pt}}}
\renewenvironment{Schunk}{\vspace{\topsep}}{\vspace{\topsep}}
\SweaveOpts{keep.source = TRUE, eps = TRUE}
<<echo=false>>=
options(continue = " ", digits = 3, width = 60, useFancyQuotes = FALSE)
@
\begin{document}
\title{An Overview of the tsdb Package}
\author{Enrico Schumann\\\url{es@enricoschumann.net}}
{\raggedright{\LARGE An Overview of the \texttt{tsdb} Package}}\medskip
\noindent Enrico Schumann\\
\noindent \url{es@enricoschumann.net}\\
\bigskip
<<echo=false>>=
require("tsdb")
require("zoo")
@
See \texttt{README.org}.
\end{document}
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