Skip to content

Commit

Permalink
Needed R documentation for header_with_hash parameter.
Browse files Browse the repository at this point in the history
  • Loading branch information
bghill committed Dec 5, 2014
1 parent e2d92d7 commit 51a4052
Show file tree
Hide file tree
Showing 7 changed files with 25 additions and 7 deletions.
2 changes: 1 addition & 1 deletion R/h2o-package/man/H2ORawData-class.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Objects can be created by calls of the form \code{new("H2ORawData", ...)}.
}
\section{Methods}{
\describe{
\item{h2o.parseRaw}{\code{signature(data = "H2OParsedData", key = "character", header = "logical" sep = "character", col.names = "H2OParsedData")}: ... }
\item{h2o.parseRaw}{\code{signature(data = "H2OParsedData", key = "character", header = "logical", header_with_hash = "logical", sep = "character", col.names = "H2OParsedData")}: ... }
\item{show}{\code{signature(object = "H2ORawData")}: ... }
}
}
Expand Down
5 changes: 4 additions & 1 deletion R/h2o-package/man/h2o.importFile.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Import Local Data File
Imports a file from the local path and parses it, returning an object containing the identifying hex key.
}
\usage{
h2o.importFile(object, path, key = "", parse = TRUE, header, sep = "", col.names,
h2o.importFile(object, path, key = "", parse = TRUE, header, header_with_hash, sep = "", col.names,
parser_type="AUTO")
}
%- maybe also 'usage' for other objects documented here.
Expand All @@ -26,6 +26,9 @@ The path of the file to be imported. Each row of data appears as one line of the
}
\item{header}{
(Optional) A logical value indicating whether the first row is the column header. If missing, H2O will automatically try to detect the presence of a header.
}
\item{header_with_hash}{
(Optional) A logical value indicating whether the first row is a column header that starts with a hash character. If missing, H2O will automatically try to detect the presence of a header.
}
\item{sep}{
(Optional) The field separator character. Values on each line of the file are separated by this character. If \code{sep = ""}, the parser will automatically detect the separator.
Expand Down
5 changes: 4 additions & 1 deletion R/h2o-package/man/h2o.importFolder.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Import Local Directory of Data Files
Imports all the files in the local directory and parses them, concatenating the data into a single H2O data matrix and returning an object containing the identifying hex key.
}
\usage{
h2o.importFolder(object, path, pattern = "", key = "", parse = TRUE, header,
h2o.importFolder(object, path, pattern = "", key = "", parse = TRUE, header, header_with_hash,
sep = "", col.names, parser_type="AUTO")
}
%- maybe also 'usage' for other objects documented here.
Expand All @@ -29,6 +29,9 @@ h2o.importFolder(object, path, pattern = "", key = "", parse = TRUE, header,
}
\item{header}{
(Optional) A logical value indicating whether the first row is the column header. If missing, H2O will automatically try to detect the presence of a header.
}
\item{header_with_hash}{
(Optional) A logical value indicating whether the first row is a column header that starts with a hash character. If missing, H2O will automatically try to detect the presence of a header.
}
\item{sep}{
(Optional) The field separator character. Values on each line of the file are separated by this character. If \code{sep = ""}, the parser will automatically detect the separator.
Expand Down
5 changes: 4 additions & 1 deletion R/h2o-package/man/h2o.importHDFS.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
Imports a HDFS file or set of files in a directory and parses them, returning a object containing the identifying hex key.
}
\usage{
h2o.importHDFS(object, path, pattern = "", key = "", parse = TRUE, header,
h2o.importHDFS(object, path, pattern = "", key = "", parse = TRUE, header, header_with_hash,
sep = "", col.names, parser_type="AUTO")
}
%- maybe also 'usage' for other objects documented here.
Expand All @@ -29,6 +29,9 @@ h2o.importHDFS(object, path, pattern = "", key = "", parse = TRUE, header,
}
\item{header}{
(Optional) A logical value indicating whether the first row is the column header. If missing, H2O will automatically try to detect the presence of a header.
}
\item{header_with_hash}{
(Optional) A logical value indicating whether the first row is a column header that starts with a hash character. If missing, H2O will automatically try to detect the presence of a header.
}
\item{sep}{
(Optional) The field separator character. Values on each line of the file are separated by this character. If \code{sep = ""}, the parser will automatically detect the separator.
Expand Down
5 changes: 4 additions & 1 deletion R/h2o-package/man/h2o.importURL.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Import Data from URL
Imports a file from the URL and parses it, returning an object containing the identifying hex key.
}
\usage{
h2o.importURL(object, path, key = "", parse = TRUE, header, sep = "", col.names,
h2o.importURL(object, path, key = "", parse = TRUE, header, hash_with_header, sep = "", col.names,
parser_type="AUTO")
}

Expand All @@ -26,6 +26,9 @@ The complete URL of the file to be imported. Each row of data appears as one lin
}
\item{header}{
(Optional) A logical value indicating whether the first row is the column header. If missing, H2O will automatically try to detect the presence of a header.
}
\item{header_with_hash}{
(Optional) A logical value indicating whether the first row is a column header that begins with a hash character. If missing, H2O will automatically try to detect the presence of a header.
}
\item{sep}{
(Optional) The field separator character. Values on each line of the file are separated by this character. If \code{sep = ""}, the parser will automatically detect the separator.
Expand Down
5 changes: 4 additions & 1 deletion R/h2o-package/man/h2o.parseRaw.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Parse Raw Data File
Parses a raw data file, returning an object containing the identifying hex key.
}
\usage{
h2o.parseRaw(data, key = "", header, sep = "", col.names,parser_type="AUTO")
h2o.parseRaw(data, key = "", header, header_with_hash, sep = "", col.names,parser_type="AUTO")
}
%- maybe also 'usage' for other objects documented here.
\arguments{
Expand All @@ -19,6 +19,9 @@ An \code{\linkS4class{H2ORawData}} object to be parsed.
}
\item{header}{
(Optional) A logical value indicating whether the first row is the column header. If missing, H2O will automatically try to detect the presence of a header.
}
\item{header_with_hash}{
(Optional) A logical value indicating whether the first row is a column header that begins with a hash character. If missing, H2O will automatically try to detect the presence of a header.
}
\item{sep}{
(Optional) The field separator character. Values on each line of the file are separated by this character. If \code{sep = ""}, the parser will automatically detect the separator.
Expand Down
5 changes: 4 additions & 1 deletion R/h2o-package/man/h2o.uploadFile.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Upload Local Data File
Uploads a file from the local drive and parses it, returning an object containing the identifying hex key.
}
\usage{
h2o.uploadFile(object, path, key = "", parse = TRUE, header,
h2o.uploadFile(object, path, key = "", parse = TRUE, header, header_with_hash,
sep = "", col.names, silent = TRUE, parser_type="AUTO")
}
%- maybe also 'usage' for other objects documented here.
Expand All @@ -27,6 +27,9 @@ The complete URL or normalized file path of the file to be imported. Each row of
}
\item{header}{
(Optional) A logical value indicating whether the first line of the file contains column headers. If left empty, the parser will try to automatically detect this.
}
\item{header_with_header}{
(Optional) A logical value indicating whether the first line of the file contain a column header that begins with a hash character. If left empty, the parser will try to automatically detect this.
}
\item{sep}{
(Optional) The field separator character. Values on each line of the file are separated by this character. If \code{sep = ""}, the parser will automatically detect the separator.
Expand Down

0 comments on commit 51a4052

Please sign in to comment.