13 changed files with 236 additions and 15 deletions
@ -0,0 +1,2 @@ |
|||
YEAR: 2020 |
|||
COPYRIGHT HOLDER: Bob Rudis |
|||
@ -0,0 +1,21 @@ |
|||
# MIT License |
|||
|
|||
Copyright (c) 2020 Bob Rudis |
|||
|
|||
Permission is hereby granted, free of charge, to any person obtaining a copy |
|||
of this software and associated documentation files (the "Software"), to deal |
|||
in the Software without restriction, including without limitation the rights |
|||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell |
|||
copies of the Software, and to permit persons to whom the Software is |
|||
furnished to do so, subject to the following conditions: |
|||
|
|||
The above copyright notice and this permission notice shall be included in all |
|||
copies or substantial portions of the Software. |
|||
|
|||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
|||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
|||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
|||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
|||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
|||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE |
|||
SOFTWARE. |
|||
@ -1,4 +1,6 @@ |
|||
# Generated by roxygen2: do not edit by hand |
|||
|
|||
import(httr) |
|||
importFrom(jsonlite,fromJSON) |
|||
export(make_my_data_file_great_again) |
|||
export(make_this_data_great_again) |
|||
export(totally_eradicate_bugs_from_data_file) |
|||
export(totally_eradicate_bugs_from_this) |
|||
|
|||
@ -1,9 +1,15 @@ |
|||
#' ... |
|||
#' |
|||
#' Totally Eradicates (Totally) Bugs in Your Data (At Least I Heard It Does!) |
|||
#' |
|||
#' Have sick/buggy data? Tools are provided to totally eradicate these bugs, leaving |
|||
#' you with beautiful (very beautiful and clean) data. One could even say you can make |
|||
#' your data great again! I've heard people say that! |
|||
#' |
|||
#' @md |
|||
#' @name lysol |
|||
#' @note The CDC — Centers for Data Coherence — has warned that using \{lysol\} on your data |
|||
#' is not recommended and may cause severe, irreparable data loss. But, what do they know? |
|||
#' Where have "science" and "experts" gotten us? Still, you should probably test \{lysoln\} |
|||
#' functions before using them in production (but only if you're one of those coward losers). |
|||
#' @keywords internal |
|||
#' @author Bob Rudis (bob@@rud.is) |
|||
#' @import httr |
|||
#' @importFrom jsonlite fromJSON |
|||
"_PACKAGE" |
|||
|
|||
@ -0,0 +1,21 @@ |
|||
#' This function totally eradicates (totally) bugs from a sick data file. (At least I heard it does!) |
|||
#' |
|||
#' @param path path to sick data file to heal |
|||
#' @note The CDC — Centers for Data Coherence — has warned that using \{lysol\} on your data |
|||
#' is not recommended and may cause severe, irreparable data loss. But, what do they know? |
|||
#' Where have "science" and "experts" gotten us? Still, you should probably test \{lyson\} |
|||
#' functions before using them in production (but only if you're one of those coward losers). |
|||
#' @export |
|||
totally_eradicate_bugs_from_data_file <- function(path) { |
|||
|
|||
path <- path.expand(path[1]) |
|||
|
|||
unlink() |
|||
|
|||
message("Your data file has been healed! You've helped flatten the curve!") |
|||
|
|||
} |
|||
|
|||
#' @rdname totally_eradicate_bugs_from_data_file |
|||
#' @export |
|||
make_my_data_file_great_again <- totally_eradicate_bugs_from_data_file |
|||
@ -0,0 +1,21 @@ |
|||
#' This function totally eradicates (totally) bugs from a sick objects. (At least I heard it does!) |
|||
#' |
|||
#' @param x R object to cleanse |
|||
#' @note The CDC — Centers for Data Coherence — has warned that using \{lysol\} on your data |
|||
#' is not recommended and may cause severe, irreparable data loss. But, what do they know? |
|||
#' Where have "science" and "experts" gotten us? Still, you should probably test \{lysoln\} |
|||
#' functions before using them in production (but only if you're one of those coward losers). |
|||
#' @return A totally cleansed object. |
|||
#' @export |
|||
totally_eradicate_bugs_from_this <- function(x) { |
|||
|
|||
message("Your object has been healed! You've helped flatten the curve!") |
|||
|
|||
invisible(NULL) |
|||
|
|||
} |
|||
|
|||
|
|||
#' @rdname totally_eradicate_bugs_from_this |
|||
#' @export |
|||
make_this_data_great_again <- totally_eradicate_bugs_from_this |
|||
@ -0,0 +1,84 @@ |
|||
|
|||
[](https://www.repostatus.org/#active) |
|||
[](https://keybase.io/hrbrmstr) |
|||
 |
|||
[](https://travis-ci.org/hrbrmstr/lysol) |
|||
 |
|||
 |
|||
|
|||
# lysol |
|||
|
|||
Totally Eradicates (Totally) Bugs in Your Data (At Least I Heard It |
|||
Does\!) |
|||
|
|||
## Description |
|||
|
|||
Have sick/buggy data? Tools are provided to totally eradicate these |
|||
bugs, leaving you with beautiful (very beautiful and clean) data. One |
|||
could even say you can make your data great again\! I’ve heard people |
|||
say that\! |
|||
|
|||
NOTE: |
|||
|
|||
> The CDC — Centers for Data Coherence — has warned that using {lysol} |
|||
> on your data is not recommended and may cause severe, irreparable data |
|||
> loss. But, what do they know? Where have “science” and “experts” |
|||
> gotten us? Still, you should probably test {lysol} functions before |
|||
> using them in production (but only if you’re one of those coward |
|||
> losers). |
|||
|
|||
## What’s Inside The Tin |
|||
|
|||
The following functions are implemented: |
|||
|
|||
- `totally_eradicate_bugs_from_data_file`: This function totally |
|||
eradicates (totally) bugs from a sick data file. (At least I heard |
|||
it does\!) |
|||
- `totally_eradicate_bugs_from_this`: This function totally eradicates |
|||
(totally) bugs from a sick objects. (At least I heard it does\!) |
|||
|
|||
## Installation |
|||
|
|||
``` r |
|||
remotes::install_git("https://git.rud.is/hrbrmstr/lysol.git") |
|||
# or |
|||
remotes::install_git("https://git.sr.ht/~hrbrmstr/lysol") |
|||
# or |
|||
remotes::install_gitlab("hrbrmstr/lysol") |
|||
# or |
|||
remotes::install_bitbucket("hrbrmstr/lysol") |
|||
# or |
|||
remotes::install_github("hrbrmstr/lysol") |
|||
``` |
|||
|
|||
NOTE: To use the ‘remotes’ install options you will need to have the |
|||
[{remotes} package](https://github.com/r-lib/remotes) installed. |
|||
|
|||
## Usage |
|||
|
|||
``` r |
|||
library(lysol) |
|||
|
|||
# current version |
|||
packageVersion("lysol") |
|||
## [1] '0.1.0' |
|||
``` |
|||
|
|||
## lysol Metrics |
|||
|
|||
| Lang | \# Files | (%) | LoC | (%) | Blank lines | (%) | \# Lines | (%) | |
|||
| :--- | -------: | --: | --: | ---: | ----------: | ---: | -------: | ---: | |
|||
| R | 4 | 0.8 | 15 | 0.65 | 12 | 0.41 | 35 | 0.51 | |
|||
| Rmd | 1 | 0.2 | 8 | 0.35 | 17 | 0.59 | 33 | 0.49 | |
|||
|
|||
## Code of Conduct |
|||
|
|||
Please note that this project is released with a Contributor Code of |
|||
Conduct. By participating in this project you agree to abide by its |
|||
terms. |
|||
@ -0,0 +1,23 @@ |
|||
% Generated by roxygen2: do not edit by hand |
|||
% Please edit documentation in R/totally-file.R |
|||
\name{totally_eradicate_bugs_from_data_file} |
|||
\alias{totally_eradicate_bugs_from_data_file} |
|||
\alias{make_my_data_file_great_again} |
|||
\title{This function totally eradicates (totally) bugs from a sick data file. (At least I heard it does!)} |
|||
\usage{ |
|||
totally_eradicate_bugs_from_data_file(path) |
|||
|
|||
make_my_data_file_great_again(path) |
|||
} |
|||
\arguments{ |
|||
\item{path}{path to sick data file to heal} |
|||
} |
|||
\description{ |
|||
This function totally eradicates (totally) bugs from a sick data file. (At least I heard it does!) |
|||
} |
|||
\note{ |
|||
The CDC — Centers for Data Coherence — has warned that using \{lysol\} on your data |
|||
is not recommended and may cause severe, irreparable data loss. But, what do they know? |
|||
Where have "science" and "experts" gotten us? Still, you should probably test \{lyson\} |
|||
functions before using them in production (but only if you're one of those coward losers). |
|||
} |
|||
@ -0,0 +1,26 @@ |
|||
% Generated by roxygen2: do not edit by hand |
|||
% Please edit documentation in R/totally-object.R |
|||
\name{totally_eradicate_bugs_from_this} |
|||
\alias{totally_eradicate_bugs_from_this} |
|||
\alias{make_this_data_great_again} |
|||
\title{This function totally eradicates (totally) bugs from a sick objects. (At least I heard it does!)} |
|||
\usage{ |
|||
totally_eradicate_bugs_from_this(x) |
|||
|
|||
make_this_data_great_again(x) |
|||
} |
|||
\arguments{ |
|||
\item{x}{R object to cleanse} |
|||
} |
|||
\value{ |
|||
A totally cleansed object. |
|||
} |
|||
\description{ |
|||
This function totally eradicates (totally) bugs from a sick objects. (At least I heard it does!) |
|||
} |
|||
\note{ |
|||
The CDC — Centers for Data Coherence — has warned that using \{lysol\} on your data |
|||
is not recommended and may cause severe, irreparable data loss. But, what do they know? |
|||
Where have "science" and "experts" gotten us? Still, you should probably test \{lysoln\} |
|||
functions before using them in production (but only if you're one of those coward losers). |
|||
} |
|||
Loading…
Reference in new issue