-
Notifications
You must be signed in to change notification settings - Fork 0
/
README.Rmd
58 lines (38 loc) · 1.57 KB
/
README.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
---
output: github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r, echo = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>"
)
```
```{r setup, include=FALSE}
knitr::opts_chunk$set(echo = TRUE)
```
[![Build Status](https://travis-ci.org/kota7/combiter.svg?branch=master)](https://travis-ci.org/kota7/combiter)
[![CRAN Status](https://www.r-pkg.org/badges/version/combiter)](https://www.r-pkg.org/badges/version/combiter)
[![](https://cranlogs.r-pkg.org/badges/combiter)](https://cran.r-project.org/package=combiter
)
[![AppVeyor Build Status](https://ci.appveyor.com/api/projects/status/github/kota7/combiter?branch=master&svg=true)](https://ci.appveyor.com/project/kota7/combiter)
# combiter: Combinatorics Iterators for R
This package provides iterators for combinations, permutations, subsets, and cartesian product, with which one can go through the elements without creating a huge set of
all possible values.
Since `v1.0.2`, the iterator objects of the package inherit the `iter` class from [iterators](https://cran.r-project.org/package=iterators) package.
As a result, the objects are also compatible with [foreach](https://cran.r-project.org/package=foreach) library.
## Installation and import
Install from CRAN by:
```{r, eval=FALSE}
install.packages("combiter")
```
Or install development version by:
```{r, eval=FALSE}
devtools::install_github("kota7/combiter")
```
Use by
```{r}
library(combiter)
```
## Usage
Please visit the [Documentation Page](https://kota7.github.io/combiter) for the package introduction.