Commit bf67fee7 authored by Nicolau Manubens's avatar Nicolau Manubens
Browse files

Updated documentation.

parent b05fcdbc
...@@ -120,6 +120,9 @@ NcToArray <- function(file_to_read, dim_indices = NULL, vars_to_read = NULL, ...@@ -120,6 +120,9 @@ NcToArray <- function(file_to_read, dim_indices = NULL, vars_to_read = NULL,
atts <- atts[-which(names(atts) %in% atts_to_remove)] atts <- atts[-which(names(atts) %in% atts_to_remove)]
} }
units <- file_object$dim[[var_name]]$units units <- file_object$dim[[var_name]]$units
if (is.null(dim(var_result))) {
dim(var_result) <- length(var_result)
}
names(dim(var_result)) <- sapply(extra_dimvars_list[[var_name]]$dim, '[[', 'name') names(dim(var_result)) <- sapply(extra_dimvars_list[[var_name]]$dim, '[[', 'name')
} else { } else {
var_result <- NULL var_result <- NULL
......
\name{NcReadVarNames}
\alias{NcReadVarNames}
\title{
Read Names of Variables in a NetCDF File
}
\description{
Reads the names of the variables in a NetCDF file and returns them as a vector of character strings.
}
\usage{
NcReadVarNames(file_to_read)
}
\arguments{
\item{file_to_read}{
Path to the file to be read or a NetCDF object as returned by \code{easyNCDF::NcOpen} or \code{ncdf4::nc_open}.
}
}
\value{
Vector of character strings with the names of the variables in the NetCDF file.
}
\examples{
}
\author{
History:\cr
0.0 - 2017-03 (N. Manubens, \email{nicolau.manubens at bsc.es}) - Original code
}
\keyword{datagen}
...@@ -11,6 +11,9 @@ Reads one or a set of variables together with metadata items from a NetCDF file ...@@ -11,6 +11,9 @@ Reads one or a set of variables together with metadata items from a NetCDF file
NcToArray(file_to_read, dim_indices = NULL, vars_to_read = NULL, NcToArray(file_to_read, dim_indices = NULL, vars_to_read = NULL,
drop_var_dim = FALSE, unlist = TRUE, drop_var_dim = FALSE, unlist = TRUE,
expect_all_indices = FALSE, allow_out_of_range = TRUE) expect_all_indices = FALSE, allow_out_of_range = TRUE)
nc2a(file_to_read, dim_indices = NULL, vars_to_read = NULL,
drop_var_dim = FALSE, unlist = TRUE,
expect_all_indices = FALSE, allow_out_of_range = TRUE)
} }
\arguments{ \arguments{
\item{file_to_read}{ \item{file_to_read}{
......
Supports Markdown
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