Data

Tools

Indexes

Applications

Experiments

Open Source Science

permutations

https://github.com/robinhankin/permutations

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Committers with academic emails
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (14.3%) to scientific vocabulary
Last synced: 7 months ago · JSON representation ·

Repository

Basic Info
Statistics
  • Stars: 7
  • Watchers: 1
  • Forks: 3
  • Open Issues: 18
  • Releases: 0
Created over 8 years ago · Last pushed 8 months ago
Metadata Files
Readme Changelog Contributing Code of conduct Citation

README.Rmd 

---
title: "Group theory in R: the permutations package"
output: github_document
---



```{r setup, include = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-",
  out.width = "100%"
)
```

# 


[![CRAN_Status_Badge](https://www.r-pkg.org/badges/version/permutations)](https://cran.r-project.org/package=permutations)
[![Codecov test coverage](https://codecov.io/gh/RobinHankin/permutations/branch/master/graph/badge.svg)](https://app.codecov.io/gh/RobinHankin/permutations?branch=master)



# Overview

The permutations package provides R-centric functionality for working
with permutations of a finite set.  It includes group-theoretic
composition of permutations and can transform from word form to cycle
form and back.


# Installation

You can install the released version of permutations from [CRAN](https://CRAN.R-project.org) with:

```{r}
# install.packages("permutations")  # uncomment this to use the package
library("permutations")
```

The package is maintained on
[github](https://github.com/RobinHankin/permutations).	

# The `permutations` package in use

Random permutations on a finite set are given by the `rperm()` command:

```{r, echo=FALSE}
set.seed(0)
```


```{r rperm}
(x <- rperm(10, 9))
```

Above, object `x` is internally stored as a matrix (word form) but the
result is printed in cycle form by default, as this is easier to
understand.  We can print in word form if we wish:


```{r wordformprint}
options(print_word_as_cycle = FALSE) # override default
as.word(x)
options(print_word_as_cycle = TRUE) # restore default: we usually want to print a cycle irregardless
```

(A dot indicates a fixed point).  The package uses arithmetic
operations `*` to combine permutations and `^` for
conjugation:

```{r arith}
(a <- as.word(c(4, 2, 3, 1, 5, 7, 6)))
(b <- as.cycle(1:4))
a * b
b * a
```

# The megaminx

The *megaminx* is a dodecahedral puzzle with similar construction to
the Rubik cube puzzle that has 50 movable pieces and 132 coloured
stickers ("facets").  The permutations package includes
functionality to simulate the megaminx and exhibits an 82-turn
superflip.  The vignette gives an extended discussion.

Owner

  • Name: Robin Hankin
  • Login: RobinHankin
  • Kind: user
  • Location: Auckland
  • Company: AUT

pushing the boundaries of R in non-statistical contexts

Citation (CITATION.cff) 

cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
- family-names: "Hankin"
  given-names: "Robin K. S."
  orcid: "https://orcid.org/0000-0001-5982-0415"
title: "The permutations R package"
version: 2.0-1
url: "https://github.com/RobinHankin/permutations"
preferred-citation:
  type: article
  authors:
  - family-names: "Hankin"
    given-names: "Robin K. S."
    orcid: "https://orcid.org/0000-0001-5982-0415"
  doi: "10.1016/j.softx.2020.100453"
  journal: "SoftwareX"
  start: 1
  end: 5
  title: "Introducing the permutations R package"
  volume: 11
  year: 2020

GitHub Events

Total
  • Issues event: 5
  • Watch event: 1
  • Issue comment event: 2
  • Push event: 46
  • Create event: 1
Last Year
  • Issues event: 5
  • Watch event: 1
  • Issue comment event: 2
  • Push event: 46
  • Create event: 1

Committers

Last synced: over 2 years ago

All Time
  • Total Commits: 272
  • Total Committers: 5
  • Avg Commits per committer: 54.4
  • Development Distribution Score (DDS): 0.037
Past Year
  • Commits: 57
  • Committers: 1
  • Avg Commits per committer: 57.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
RobinHankin h****n@g****m 262
Robin Hankin r****n@w****z 4
Robin Hankin R****n 4
pegeler 3****r 1
sarahemarshall 4****l 1
Committer Domains (Top 20 + Academic)
wt106-836wsm.autuni.aut.ac.nz: 1

Issues and Pull Requests

Last synced: 8 months ago

All Time
  • Total issues: 54
  • Total pull requests: 2
  • Average time to close issues: about 1 year
  • Average time to close pull requests: about 13 hours
  • Total issue authors: 3
  • Total pull request authors: 2
  • Average comments per issue: 1.02
  • Average comments per pull request: 1.0
  • Merged pull requests: 2
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 6
  • Pull requests: 0
  • Average time to close issues: 8 days
  • Average time to close pull requests: N/A
  • Issue authors: 1
  • Pull request authors: 0
  • Average comments per issue: 0.67
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • RobinHankin (52)
  • magviana (1)
  • stla (1)
Pull Request Authors
  • pegeler (1)
  • sarahemarshall (1)
Top Labels
Issue Labels
bug (1) suggestion (1) enhancement (1)
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • cran 480 last-month
  • Total docker downloads: 43,390
  • Total dependent packages: 3
  • Total dependent repositories: 3
  • Total versions: 9
  • Total maintainers: 1
cran.r-project.org: permutations

The Symmetric Group: Permutations of a Finite Set

  • Versions: 9
  • Dependent Packages: 3
  • Dependent Repositories: 3
  • Downloads: 480 Last month
  • Docker Downloads: 43,390
Rankings
Docker downloads count: 0.6%
Dependent packages count: 10.9%
Average: 14.1%
Forks count: 14.2%
Dependent repos count: 16.5%
Stargazers count: 20.6%
Downloads: 21.9%
Maintainers (1)
hankin.robin@gmail.com
Last synced: 8 months ago

Dependencies

DESCRIPTION cran
  • R >= 3.5.0 depends
  • methods * depends
  • freealg >= 1.0 imports
  • magic * imports
  • mathjaxr * imports
  • numbers * imports
  • partitions >= 1.9 imports
  • knitr * suggests
  • magrittr * suggests
  • rmarkdown * suggests
  • testthat * suggests
.github/workflows/R-CMD-check.yaml actions
  • actions/checkout v4 composite
  • r-lib/actions/check-r-package v2 composite
  • r-lib/actions/setup-r v2 composite
  • r-lib/actions/setup-r-dependencies v2 composite
  • r-lib/actions/setup-tinytex v2 composite
.github/workflows/pkgdown.yaml actions
  • JamesIves/github-pages-deploy-action v4.5.0 composite
  • actions/checkout v4 composite
  • r-lib/actions/setup-pandoc v2 composite
  • r-lib/actions/setup-r v2 composite
  • r-lib/actions/setup-r-dependencies v2 composite
.github/workflows/recheck.yml actions
.github/workflows/test-coverage.yaml actions
  • actions/checkout v4 composite
  • actions/upload-artifact v4 composite
  • codecov/codecov-action v4 composite
  • r-lib/actions/setup-r v2 composite
  • r-lib/actions/setup-r-dependencies v2 composite