-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathREADME.Rmd
170 lines (133 loc) · 7.36 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
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
---
output: rmarkdown::github_document
always_allow_html: true
---
```{r, echo = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "",
fig.path = "inst/extdata/"
)
```
<!--
```{r, out.width = '20%', echo = FALSE, eval = TRUE}
knitr::include_graphics("https://raw.githubusercontent.com/aravind-j/gglyph/master/inst/extdata/gglyph.png")
```
-->
## `gglyph`: Multivariate Data Visualization using Glyphs <img src="https://raw.githubusercontent.com/aravind-j/gglyph/master/inst/extdata/gglyph.png" align="right" alt="logo" width="173" height = "200" style = "border: none; float: right;">
```{r,echo = FALSE, message = FALSE}
devtools::load_all(".", quiet = TRUE) # quiet = T for hiding macOS compiler warnings
```
###### Version : [`r getNamespaceVersion("gglyph")`](https://aravind-j.github.io/gglyph/); License: [GPL-2|GPL-3](https://www.r-project.org/Licenses/)
##### Aravind, J.
Division of Germplasm Conservation, ICAR-National Bureau of Plant Genetic Resources, New Delhi.
***
[](https://cran.r-project.org/)
[](https://www.gnu.org/licenses/gpl-3.0)
[](https://cran.r-project.org/package=gglyph)
[](https://cran.r-project.org/package=gglyph)
[](https://CRAN.R-project.org/package=gglyph)
```{r, results='asis', echo=FALSE}
dver <- ifelse(test = gsub("(.\\.)(\\d+)(\\..)", "", getNamespaceVersion("gglyph")) != "",
yes = getNamespaceVersion("gglyph"),
no = gsub("Version:\\s*", "", readLines(paste0("https://raw.githubusercontent.com/", "aravind-j/gglyph", "/master/DESCRIPTION"))[grep("Version:", readLines(paste0("https://raw.githubusercontent.com/", "aravind-j/gglyph", "/master/DESCRIPTION")))]))
cat(paste("[![develVersion](https://img.shields.io/badge/devel%20version-", dver, "-orange.svg)](https://github.com/aravind-j/gglyph)", sep = ""))
```
[](https://github.com/aravind-j/gglyph)
[](https://github.com/aravind-j/gglyph/actions)
[](https://www.repostatus.org/#wip)
[](https://lifecycle.r-lib.org/articles/stages.html#maturing)
[)`-yellowgreen.svg)](https://github.com/aravind-j/gglyph/)
<!-- [](https://doi.org/10.5281/zenodo.xxxxxxxx) -->
[](https://aravind-j.github.io/gglyph/)
[](https://github.com/aravind-j/google-analytics-beacon)
<!-- [](https://github.com/aravind-j/gglyph) -->
<!-- [] -->
<!-- [](http://www.rdocumentation.org/packages/gglyph) -->
***
## Description
`r gsub("(<doi:)(.+)(>)", "[doi:\\2](https://doi.org/\\2)", gsub("\\n", " ", packageDescription("gglyph", fields = "Description")))`
## Installation
<!-- The package can be installed from CRAN as follows: -->
```{r, eval=FALSE, echo=FALSE}
# Install from CRAN
install.packages('gglyph', dependencies=TRUE)
```
The development version can be installed from github as follows:
```{r, eval=FALSE}
# Install development version from Github
devtools::install_github("aravind-j/gglyph")
```
<!-- ## Detailed tutorial
For a detailed tutorial (vignette) on how to used this package type:
```{r, eval=FALSE}
browseVignettes(package = 'gglyph')
```
The vignette for the latest version is also available [online](https://aravind-j.github.io/gglyph/articles.html).-->
## What's new
To know whats new in this version type:
```{r, eval=FALSE}
news(package='gglyph')
```
## Links
<!-- [CRAN page](https://cran.r-project.org/package=gglyph) -->
[Github page](https://github.com/aravind-j/gglyph)
[Documentation website](https://aravind-j.github.io/gglyph/)
<!-- [Zenodo DOI](https://doi.org/10.5281/zenodo.xxxxxxx) -->
<!-- ## CRAN checks -->
```{r, echo = FALSE, eval=FALSE}
pkgname <- "gglyph"
osdf <-
rbind(data.frame(OS = "Linux",
Flavour = c("r-devel-linux-x86_64-debian-clang",
"r-devel-linux-x86_64-debian-gcc",
"r-devel-linux-x86_64-fedora-clang",
"r-devel-linux-x86_64-fedora-gcc",
"r-patched-linux-x86_64",
"r-release-linux-x86_64")),
data.frame(OS = "Solaris",
Flavour = c("r-patched-solaris-x86")),
data.frame(OS = "Windows",
Flavour = c("r-devel-windows-ix86+x86_64",
"r-release-windows-ix86+x86_64",
"r-oldrel-windows-ix86+x86_64")),
data.frame(OS = "macOS",
Flavour = c("r-release-macos-x86_64",
"r-oldrel-macos-x86_64")))
osdf$`CRAN check` <- paste("[![CRAN check - ", osdf$Flavour, "]",
"(https://cranchecks.info/badges/flavor/",
osdf$Flavour, "/", pkgname, ")]",
"(https://cran.r-project.org/web/checks/check_results_",
pkgname, ".html)",
sep = "")
```
```{r, echo = FALSE, results='asis', eval=FALSE}
library(kableExtra, warn.conflicts = FALSE)
kosdf <- kbl(osdf[, c("Flavour", "CRAN check")], row.names = FALSE)
kosdf2 <- kable_styling(kosdf, bootstrap_options = c("striped", "hover"),
full_width = F, position = "left")
pack_rows(kosdf2, index = c("[](https://cran.r-project.org/web/checks/check_results_ammistability.html)" = 6,
"[](https://cran.r-project.org/web/checks/check_results_ammistability.html)" = 1,
"[](https://cran.r-project.org/web/checks/check_results_ammistability.html)" = 3,
"[](https://cran.r-project.org/web/checks/check_results_ammistability.html)" = 2))
```
## Citing `gglyph`
To cite the methods in the package use:
```{r, eval = FALSE}
citation("gglyph")
```
```{r, echo = FALSE}
detach("package:gglyph", unload = TRUE)
suppressPackageStartupMessages(library(gglyph))
cit <- citation("gglyph")
# yr <- format(Sys.Date(), "%Y")
# cit[1]$year <- yr
# oc <- class(cit)
#
# cit <- unclass(cit)
# attr(cit[[1]],"textVersion") <- gsub("\\(\\)",
# paste("\\(", yr, "\\)", sep = ""),
# attr(cit[[1]],"textVersion"))
# class(cit) <- oc
cit
```