forked from r-lib/available
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathREADME.Rmd
63 lines (47 loc) · 1.65 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
59
60
61
62
63
---
output: github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r, echo = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "README-"
)
```
[![Travis-CI Build Status](https://travis-ci.org/ropenscilabs/available.svg?branch=master)](https://travis-ci.org/ropenscilabs/available)
[![CRAN status](http://www.r-pkg.org/badges/version/available)](https://cran.r-project.org/package=available)
[![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
<p align="center">
<img src="http://i.imgur.com/1KZn3Z5.jpg" alt="xzibit">
</p>
\
# available
> available helps you name your R package.
- Checks for validity
- Checks not already available on GitHub, CRAN and Bioconductor
- Searches Urban Dictionary, Wiktionary and Wikipedia for unintended meanings
- Can suggest possible names based on text in the package title or description.
## Installation
You can install available from CRAN with:
```{r CRAN-installation, eval = FALSE}
install.packages("available")
```
Or the development version from GitHub with:
```{r gh-installation, eval = FALSE}
# install.packages("devtools")
devtools::install_github("ropenscilabs/available")
```
## Examples
<p align="center">
<img src="http://i.imgur.com/tA1VdaH.png">
</p>
\
## Generate new package names from titles
```{r}
library(available)
suggest(text = "Client for New York Times APIs")
suggest(text = "An R Interface to SciDB")
```
### Rstudio Support
RStudio versions 1.1 and later support color in the terminal.