magclass v4.107.0

0

Monthly downloads

0th

Percentile

Data Class and Tools for Handling Spatial-Temporal Data

Data class for increased interoperability working with spatial- temporal data together with corresponding functions and methods (conversions, basic calculations and basic data manipulation). The class distinguishes between spatial, temporal and other dimensions to facilitate the development and interoperability of tools build for it. Additional features are name-based addressing of data and internal consistency checks (e.g. checking for the right data order in calculations).

Readme

R magclass package

Purpose and Functionality

The magclass package provides a data class for increased interoperability working with spatial-temporal data together with corresponding functions and methods (conversions, basic calculations and basic data manipulation). The class distinguishes between spatial, temporal and other dimensions to facilitate the development and interoperability of tools build for it. Additional features are name-based addressing of data and internal consistency checks (e.g. checking for the right data order in calculations).

Installation

The last official release of the package can be directly installed from official CRAN repository:

install.packages("magclass")

For installation of the most recent package version an additional repository has to be added in R:

options(repos = c(CRAN = "@CRAN@", rd3mod_repo = "http://www.pik-potsdam.de/rd3mod/R/"))

The additional repository can be made availably permanently by adding the line above to a file called .Rprofile stored in the home folder of your system (Sys.glob("~") in R returns the home directory).

After that the most recent version of the package can be installed using install.packages:

install.packages("magclass")

Package updates can be installed using update.packages (make sure that the additional repository has been added before running that command):

update.packages()

Tutorial

The package comes with a vignette describing the basic functionality of the package and how to use it. You can load it with the following command (the package needs to be installed):

vignette("magclass")

Travis CI Integration

Travis build status

Questions / Problems

In case of questions / problems please contact Jan Dietrich dietrich@pik-potsdam.de.

Citation

DOI

Functions in magclass

Name Description
add_columns add_columns
dimSums Summation over dimensions
clean_magpie MAgPIE-Clean
add_dimension add_dimension
dimOrder dimOrder
getItems Get Items
magclassdata magclassdata
magclass-package Data Class and Tools for Handling Spatial-Temporal Data
dimCode dimCode
getMetadata getMetadata (!experimental!)
calibrate_it calibrate_it
getCPR Get cells per region
mbind mbind
mcalc mcalc
getCells Get Cells
lin.convergence lin.convergence
lowpass Lowpass Filter
new.magpie new.magpie
old_dim_convention old_dim_convention
colSums-methods ~~ Methods for Function colSums and colMeans ~~
updateMetadata updateMetadata (!experimental!)
getRegionList Get a list of celluare region-belongings
convergence convergence
convert.report Converts a report from one model to another
getRegions Get regions
getSets Get sets
install_magpie_units install_magpie_units (!experimental!)
is.temporal is.temporal, is.spatial
magpiesort MAgPIE-Sort
magpply magpply
place_x_in_y place_x_in_y
escapeRegex escapeRegex
where where
write.report Write file in report format
fulldim Reconstructs full dimensionality of MAgPIE objects
magpieResolution magpieResolution
write.report2 Write file in report format
magpie_expand magpie_expand
read.report Read file in report format
population_magpie population_magpie
isYear isYear
is_unit_installed is_unit_installed (!experimental!)
getDim getDim
magpie-class Class "magpie" ~~~
getComment getComment
getYears Get years
sizeCheck sizeCheck
remind2magpie Remind2MAgPIE
time_interpolate time_interpolate
withMetadata withMetadata (!experimental!)
magpieComp magpieComp
print.magpie print
write.reportProject Write file in specific project format
read.magpie Read MAgPIE-object from file
setNames-methods Get dataset names
set_magpie_units set_magpie_units (!experimental!)
wrap Wrap
head.magpie head/tail
mselect MSelect
ncells Count elements
round-methods Round-method for MAgPIE objects
rowSums-methods ~~ Methods for Function rowSums and rowMeans ~~
write.magpie Write MAgPIE-object to file
write.magpie.ncdf write.magpie.ncdf
units<-.magpie units
unwrap Unwrap
collapseNames Collapse dataset names
complete_magpie complete_magpie
copy.attributes Copy Attributes
are_units_convertible are_units_convertible (!experimental!)
as.array-methods ~~ Methods for Function as.array ~~
dimReduce dimReduce
as.data.frame-methods ~~ Methods for Function as.data.frame ~~
getNames Get dataset names
copy.magpie Copy MAgPIE-files
No Results!

Vignettes of magclass

Name
magclass-concept.Rmd
magclass-concept.md
magclass.Rmd
magclass.md
No Results!

Last month downloads

Details

Type Package
Date 2019-05-28
URL https://github.com/pik-piam/magclass, https://doi.org/10.5281/zenodo.1158580
BugReports https://github.com/pik-piam/magclass/issues
License LGPL-3 | file LICENSE
LazyData true
Encoding UTF-8
RoxygenNote 6.1.1
VignetteBuilder knitr
NeedsCompilation no
Packaged 2019-05-28 21:45:36 UTC; jpd
Repository CRAN
Date/Publication 2019-05-29 08:00:14 UTC

Include our badge in your README

[![Rdoc](http://www.rdocumentation.org/badges/version/magclass)](http://www.rdocumentation.org/packages/magclass)