[Genabel-commits] r1934 - pkg/DatABEL/man
noreply at r-forge.r-project.org
noreply at r-forge.r-project.org
Mon Mar 30 13:22:26 CEST 2015
Author: lckarssen
Date: 2015-03-30 13:22:26 +0200 (Mon, 30 Mar 2015)
New Revision: 1934
Modified:
pkg/DatABEL/man/DatABEL-package.Rd
pkg/DatABEL/man/apply2dfo.Rd
pkg/DatABEL/man/databel-class.Rd
pkg/DatABEL/man/databel.Rd
pkg/DatABEL/man/databel2matrix.Rd
pkg/DatABEL/man/databel2text.Rd
pkg/DatABEL/man/extract_text_file_columns.Rd
pkg/DatABEL/man/get_temporary_file_name.Rd
pkg/DatABEL/man/make_empty_fvf.Rd
pkg/DatABEL/man/matrix2databel.Rd
pkg/DatABEL/man/process_lm_output.Rd
pkg/DatABEL/man/text2databel.Rd
Log:
Newly generated DatABEL documentation (using Roxygen2) after running document() from the devtools package.
Modified: pkg/DatABEL/man/DatABEL-package.Rd
===================================================================
--- pkg/DatABEL/man/DatABEL-package.Rd 2015-03-30 11:20:25 UTC (rev 1933)
+++ pkg/DatABEL/man/DatABEL-package.Rd 2015-03-30 11:22:26 UTC (rev 1934)
@@ -1,4 +1,5 @@
-% Generated by roxygen2 (4.0.1): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
+% Please edit documentation in R/DatABEL-package.R
\docType{package}
\name{DatABEL-package}
\alias{"DatABEL"}
Modified: pkg/DatABEL/man/apply2dfo.Rd
===================================================================
--- pkg/DatABEL/man/apply2dfo.Rd 2015-03-30 11:20:25 UTC (rev 1933)
+++ pkg/DatABEL/man/apply2dfo.Rd 2015-03-30 11:22:26 UTC (rev 1934)
@@ -1,4 +1,5 @@
-% Generated by roxygen2 (4.0.1): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
+% Please edit documentation in R/apply2dfo.R
\name{apply2dfo}
\alias{apply2dfo}
\title{applies a function to a 'databel' object}
@@ -7,6 +8,8 @@
outclass = "matrix", outfile, type = "DOUBLE", transpose = TRUE)
}
\arguments{
+\item{...}{arguments passed to the \code{anFUN}}
+
\item{dfodata}{'databel' object which is iterated over}
\item{anFUN}{user-defined analysis function}
@@ -31,8 +34,6 @@
storage}
\item{transpose}{whether to transpose the output}
-
-\item{...}{arguments passed to the \code{anFUN}}
}
\value{
A matrix (or 'databel'-matrix) containing results of
Modified: pkg/DatABEL/man/databel-class.Rd
===================================================================
--- pkg/DatABEL/man/databel-class.Rd 2015-03-30 11:20:25 UTC (rev 1933)
+++ pkg/DatABEL/man/databel-class.Rd 2015-03-30 11:22:26 UTC (rev 1934)
@@ -1,4 +1,5 @@
-% Generated by roxygen2 (4.0.1): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
+% Please edit documentation in R/databel_class.R
\docType{class}
\name{databel-class}
\alias{[,databel-method}
@@ -62,55 +63,29 @@
setReadOnly(x) <- value
}
\arguments{
+\item{object}{A DatABEL object}
+
+\item{x}{A DatABEL object}
+
+\item{value}{Values to be replaced/inserted}
+
+\item{i}{Row index}
+
\item{j}{Column index}
-\item{file}{Filename to save to}
+\item{drop}{Boolean (FALSE by default); UNUSED}
\item{rows}{Index for the rows}
\item{cols}{Index for the columns}
+\item{file}{Filename to save to}
+
\item{cachesizeMb}{Amount (in MB) of RAM to use for caching DatABEL
data.}
\item{readonly}{Boolean that specifies whether the file is to be
used in read-only mode or not}
-
-\item{object}{Any R object}
-
-\item{x}{an \R object, for example a matrix, array or data frame.}
-
-\item{value}{For the default method, either \code{NULL} or
- a numeric vector, which is coerced to integer (by truncation).}
-
-\item{i}{
- indices specifying elements to extract or replace. Indices are
- \code{numeric} or \code{character} vectors or empty (missing) or
- \code{NULL}. Numeric values are coerced to integer as by
- \code{\link{as.integer}} (and hence truncated towards zero).
- Character vectors will be matched to the \code{\link{names}} of the
- object (or for matrices/arrays, the \code{\link{dimnames}}):
- see \sQuote{Character indices} below for further details.
-
- For \code{[}-indexing only: \code{i}, \code{j}, \code{\dots} can be
- logical vectors, indicating elements/slices to select. Such vectors
- are recycled if necessary to match the corresponding extent.
- \code{i}, \code{j}, \code{\dots} can also be negative integers,
- indicating elements/slices to leave out of the selection.
-
- When indexing arrays by \code{[} a single argument \code{i} can be a
- matrix with as many columns as there are dimensions of \code{x}; the
- result is then a vector with elements corresponding to the sets of
- indices in each row of \code{i}.
-
- An index value of \code{NULL} is treated as if it were \code{integer(0)}.
- }
-
-\item{drop}{For matrices and arrays. If \code{TRUE} the result is
- coerced to the lowest possible dimension (see the examples). This
- only works for extracting elements, not for the replacement. See
- \code{\link{drop}} for further details.
- }
}
\description{
DatABEL stores matrix-shape data in such a way that it can be
Modified: pkg/DatABEL/man/databel.Rd
===================================================================
--- pkg/DatABEL/man/databel.Rd 2015-03-30 11:20:25 UTC (rev 1933)
+++ pkg/DatABEL/man/databel.Rd 2015-03-30 11:22:26 UTC (rev 1934)
@@ -1,4 +1,5 @@
-% Generated by roxygen2 (4.0.1): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
+% Please edit documentation in R/databel.R
\name{databel}
\alias{databel}
\title{initiates databel object}
Modified: pkg/DatABEL/man/databel2matrix.Rd
===================================================================
--- pkg/DatABEL/man/databel2matrix.Rd 2015-03-30 11:20:25 UTC (rev 1933)
+++ pkg/DatABEL/man/databel2matrix.Rd 2015-03-30 11:22:26 UTC (rev 1934)
@@ -1,4 +1,5 @@
-% Generated by roxygen2 (4.0.1): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
+% Please edit documentation in R/databel2matrix.R
\name{databel2matrix}
\alias{databel2matrix}
\title{converts 'databel' to matrix}
Modified: pkg/DatABEL/man/databel2text.Rd
===================================================================
--- pkg/DatABEL/man/databel2text.Rd 2015-03-30 11:20:25 UTC (rev 1933)
+++ pkg/DatABEL/man/databel2text.Rd 2015-03-30 11:22:26 UTC (rev 1934)
@@ -1,4 +1,5 @@
-% Generated by roxygen2 (4.0.1): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
+% Please edit documentation in R/databel2text.R
\name{databel2text}
\alias{databel2text}
\title{Exports DatABEL object to a text file}
Modified: pkg/DatABEL/man/extract_text_file_columns.Rd
===================================================================
--- pkg/DatABEL/man/extract_text_file_columns.Rd 2015-03-30 11:20:25 UTC (rev 1933)
+++ pkg/DatABEL/man/extract_text_file_columns.Rd 2015-03-30 11:22:26 UTC (rev 1934)
@@ -1,4 +1,5 @@
-% Generated by roxygen2 (4.0.1): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
+% Please edit documentation in R/extract_text_file_columns.R
\name{extract_text_file_columns}
\alias{extract_text_file_columns}
\title{extracts columns from text file}
Modified: pkg/DatABEL/man/get_temporary_file_name.Rd
===================================================================
--- pkg/DatABEL/man/get_temporary_file_name.Rd 2015-03-30 11:20:25 UTC (rev 1933)
+++ pkg/DatABEL/man/get_temporary_file_name.Rd 2015-03-30 11:22:26 UTC (rev 1934)
@@ -1,4 +1,5 @@
-% Generated by roxygen2 (4.0.1): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
+% Please edit documentation in R/get_temporary_file_name.R
\name{get_temporary_file_name}
\alias{get_temporary_file_name}
\title{generates temporary file name}
Modified: pkg/DatABEL/man/make_empty_fvf.Rd
===================================================================
--- pkg/DatABEL/man/make_empty_fvf.Rd 2015-03-30 11:20:25 UTC (rev 1933)
+++ pkg/DatABEL/man/make_empty_fvf.Rd 2015-03-30 11:22:26 UTC (rev 1934)
@@ -1,4 +1,5 @@
-% Generated by roxygen2 (4.0.1): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
+% Please edit documentation in R/make_empty_fvf.R
\name{make_empty_fvf}
\alias{make_empty_fvf}
\title{makes empty filevector object}
Modified: pkg/DatABEL/man/matrix2databel.Rd
===================================================================
--- pkg/DatABEL/man/matrix2databel.Rd 2015-03-30 11:20:25 UTC (rev 1933)
+++ pkg/DatABEL/man/matrix2databel.Rd 2015-03-30 11:22:26 UTC (rev 1934)
@@ -1,4 +1,5 @@
-% Generated by roxygen2 (4.0.1): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
+% Please edit documentation in R/matrix2databel.R
\name{matrix2databel}
\alias{matrix2databel}
\title{converts matrix to 'databel'}
Modified: pkg/DatABEL/man/process_lm_output.Rd
===================================================================
--- pkg/DatABEL/man/process_lm_output.Rd 2015-03-30 11:20:25 UTC (rev 1933)
+++ pkg/DatABEL/man/process_lm_output.Rd 2015-03-30 11:22:26 UTC (rev 1934)
@@ -1,4 +1,5 @@
-% Generated by roxygen2 (4.0.1): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
+% Please edit documentation in R/apply2dfo_util.R
\name{process_lm_output}
\alias{process_lm_output}
\alias{process_simple_output}
Modified: pkg/DatABEL/man/text2databel.Rd
===================================================================
--- pkg/DatABEL/man/text2databel.Rd 2015-03-30 11:20:25 UTC (rev 1933)
+++ pkg/DatABEL/man/text2databel.Rd 2015-03-30 11:22:26 UTC (rev 1934)
@@ -1,4 +1,5 @@
-% Generated by roxygen2 (4.0.1): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
+% Please edit documentation in R/text2databel.R
\name{text2databel}
\alias{text2databel}
\title{converts text file to filevector format}
More information about the Genabel-commits
mailing list