name_split: Returns a summary data frame of ".gz" encoded oceanography...

View source: R/name_split.r

name_splitR Documentation

Returns a summary data frame of '.gz' encoded oceanography files by splitting their name

Description

Returns a summary data.frame of '.gz' encoded oceanography files by splitting their name

Usage

name_split(gz.files)
get.gz.info(gz.files)

Arguments

gz.files

Optional character vector or search criteria for .gz-encoded oceanography files.

Value

Returns a summary data.frame of '.gz' encoded oceanography files by splitting their name

area source parameter resolution timestep date1 date2 option

area

region keyword

source

data source

param

the parameter saved in the '.gz'-file. Can only be one value!

resolution

the spatial resolution

timestep

the temporal resolution

date1 & date2

the time interval covered in date format

option

a character string holding supplmentary information of '.gz'-file treatment

Author(s)

Robert K. Bauer

See Also

See check_gzfiles to return summary of available '.gz'-files and name_join to create '.gz'-filenames from splitted names (name_split)-calls

Examples

## Example: read and plot '.gz'-file
path <- system.file("test_files", package="oceanmap")
gz.files <- Sys.glob(paste0(path,'/*.gz')) # load sample-'.gz'-files
check_gzfiles(folder=path) # return file summary-table

# return summary of availble '.gz'-files
# suffix-column corresponds to option column of the name_split-call
# addition n-column returns the number of available files per filetype
check_gzfiles(gz.files)

## Example: split and rejoin '.gz'-filenames
gz.files
name_split(gz.files) # return summary-table per file
name_split() # return summary-table of all gz-file in current folder
name_join(name_split(gz.files))

oceanmap documentation built on Nov. 10, 2023, 5:08 p.m.