Code Monkey home page Code Monkey logo

madrat's Introduction

May All Data be Reproducible and Transparent (MADRaT) *

R package madrat, version 2.20.7

CRAN status DOI R build status codecov r-universe

Purpose and Functionality

Provides a framework which should improve reproducibility and transparency in data processing. It provides functionality such as automatic meta data creation and management, rudimentary quality management, data caching, work-flow management and data aggregation. * The title is a wish not a promise. By no means we expect this package to deliver everything what is needed to achieve full reproducibility and transparency, but we believe that it supports efforts in this direction.

Installation

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

options(repos = c(CRAN = "@CRAN@", pik = "https://rse.pik-potsdam.de/r/packages"))

The additional repository can be made available 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("madrat")

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 vignettes describing the basic functionality of the package and how to use it. You can load them with the following command (the package needs to be installed):

vignette("madrat-caching") # Data caching in madrat
vignette("madrat-puc")     # Portable unagreggated collections (PUCs) in MADRaT
vignette("madrat")         # Data preparation with madrat

Questions / Problems

In case of questions / problems please contact Jan Philipp Dietrich [email protected].

Citation

To cite package madrat in publications use:

Dietrich J, Baumstark L, Wirth S, Giannousakis A, Rodrigues R, Bodirsky B, Kreidenweis U, Klein D, Führlich P (2022). madrat: May All Data be Reproducible and Transparent (MADRaT). doi: 10.5281/zenodo.1115490 (URL: https://doi.org/10.5281/zenodo.1115490), R package version 2.20.7, <URL: https://github.com/pik-piam/madrat>.

A BibTeX entry for LaTeX users is

@Manual{,
 title = {madrat: May All Data be Reproducible and Transparent (MADRaT)},
 author = {Jan Philipp Dietrich and Lavinia Baumstark and Stephen Wirth and Anastasis Giannousakis and Renato Rodrigues and Benjamin Leon Bodirsky and Ulrich Kreidenweis and David Klein and Pascal Führlich},
 year = {2022},
 note = {R package version 2.20.7},
 doi = {10.5281/zenodo.1115490},
 url = {https://github.com/pik-piam/madrat},
}

madrat's People

Contributors

0umfhxcvx5j7joaohfss5mncnistjj6q avatar bodirsky avatar bs538 avatar caviddhen avatar christophbertram avatar dklein-pik avatar fbenke-pik avatar felicitasbeier avatar flohump avatar giannou avatar k4rst3ns avatar laviniabaumstark avatar loisel avatar mikapfl avatar mishkos avatar pfuehrlich-pik avatar pre-commit-ci[bot] avatar renato-rodrigues avatar stephenbi avatar stephnwirth avatar tscheypidi avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.