https://github.com/krzjoa/eponge

Keep your environment clean
https://github.com/krzjoa/eponge

Last synced: 5 days ago
JSON representation

Keep your environment clean

• Host: GitHub
• URL: https://github.com/krzjoa/eponge
• Owner: krzjoa
• License: other
• Created: 2020-02-01T18:07:58.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2020-03-26T19:21:44.000Z (almost 5 years ago)
• Last Synced: 2024-12-08T15:03:33.433Z (25 days ago)
• Language: R
• Homepage: https://krzjoa.github.io/eponge/
• Size: 18 MB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.Rmd
  • License: LICENSE

Awesome Lists containing this project

README

        
---

output: github_document

---

```{r, include = FALSE}

knitr::opts_chunk$set(

  collapse = TRUE,

  comment = "#>",

  fig.path = "man/figures/README-",

  out.width = "100%"

)

```

# eponge 

> Keep your environment clean

[![CRAN status](https://www.r-pkg.org/badges/version/eponge)](https://CRAN.R-project.org/package=eponge)

[![Documentation](https://img.shields.io/badge/documentation-eponge-orange.svg?colorB=E91E63)](http://krzjoa.github.io/eponge/)

[![Travis build status](https://travis-ci.org/krzjoa/eponge.svg?branch=master)](https://travis-ci.org/krzjoa/eponge)

[![AppVeyor build status](https://ci.appveyor.com/api/projects/status/github/krzjoa/eponge?branch=master&svg=true)](https://ci.appveyor.com/project/krzjoa/eponge)

[![Buy hex stciker](https://img.shields.io/badge/buy%20hex-eponge-green)](https://www.redbubble.com/people/krzjoa/works/44569100-eponge-r-package-hex?asc=u&kind=sticker&p=sticker&size=small)

A small utility which makes selective objects removing easier.

## Installation

You can install `eponge` package from CRAN:

```r

install.packages("eponge")

```

or from GitHub:

``` r

# install.packages("devtools")

devtools::install_github("krzjoa/eponge")

```

## Usage

Many times we can meet a situation, when we want to clean our environment selectively.

Suppose we just wrote a couple of functions, which have the same names as the ones

existing in already attached libraries.

```r

filter <- function(x, id){

  x %>% 

  filter(ID == id)

}

cars <- 1:5

eponge::erase_masking()

```

Sometimes, we may want to tidy our messy enivironment: we have objects we would like to keep, while in the same time there are many temporary objects created during the exploration.

```r

cars.2 <- cars

cars.2$speed <- cars.2$speed + 2

new.iris <- iris[1:20, ]

add_two <- function(x) x + 2

# Normally, we don't have to pass envir argument, because it indicates global environment by default

eponge::erase_data(envir = environment())

```

## Package name

Package was originally named `sponge`, but it was changed in order to avoid name conflict with BioConductor package [SPONGE](https://www.bioconductor.org/packages/release/bioc/html/SPONGE.html). The current name comes from its French equivalent, **éponge (e.pɔ̃ʒ)**.