@@ -12,8 +12,10 @@ status](https://www.r-pkg.org/badges/version/ggseqplot)](https://cran.r-project.
12
12
coverage] ( https://codecov.io/gh/maraab23/ggseqplot/branch/main/graph/badge.svg )] ( https://app.codecov.io/gh/maraab23/ggseqplot?branch=main )
13
13
[ ![ CRAN
14
14
Downloads] ( https://cranlogs.r-pkg.org/badges/grand-total/ggseqplot )] ( https://cranlogs.r-pkg.org/badges/grand-total/ggseqplot )
15
- [ ![ Codecov test
16
- coverage] ( https://codecov.io/gh/maraab23/ggseqplot/graph/badge.svg )] ( https://app.codecov.io/gh/maraab23/ggseqplot )
15
+ [ ![ pkgdown] ( https://img.shields.io/badge/docs-pkgdown-blue.svg )] ( https://maraab23.github.io/ggseqplot/ )
16
+ [ ![ License:
17
+ GPL-3] ( https://img.shields.io/badge/license-GPL--3-blue.svg )] ( https://cran.r-project.org/web/licenses/GPL-3 )
18
+
17
19
<!-- badges: end -->
18
20
19
21
The main goal of [ ` {ggseqplot} ` ] ( https://maraab23.github.io/ggseqplot/ )
@@ -33,19 +35,19 @@ of the their functions to produce ggplot2-flavored figures.
33
35
34
36
Note, that this library was not written because I personally dislike the
35
37
plots produced by <a href="http://traminer.unige.ch "
36
- target="_ blank"><code >{TraMineR}</code ></a >, but rather because I am
37
- normally using <a href="https://ggplot2.tidyverse.org/ "
38
+ target="_ blank"><code >{TraMineR}</code ></a >, but rather because I
39
+ normally use <a href="https://ggplot2.tidyverse.org/ "
38
40
target="_ blank"><code >{ggplot2}</code ></a > instead of base R’s ` plot `
39
- environment for visualizing data. <a href="http://traminer.unige.ch "
41
+ environment for data visualization . <a href="http://traminer.unige.ch "
40
42
target="_ blank"><code >{TraMineR}</code ></a > was developed before
41
43
<a href="https://ggplot2.tidyverse.org/ "
42
- target="_ blank"><code >{ggplot2}</code ></a > was as popular as it is today
43
- and back then many users were more familiar with coding base R plots. To
44
- date, however, many researchers and students are more accustomed to
45
- using <a href="https://ggplot2.tidyverse.org/ "
46
- target="_ blank"><code >{ggplot2}</code ></a > and prefer to draw on the
47
- related skills and experiences instead of learning how to refine base R
48
- plots just for the single purpose of visualizing sequence data.
44
+ target="_ blank"><code >{ggplot2}</code ></a > became as popular as it is
45
+ today, when most users were more familiar with base R plots. Today,
46
+ however, many researchers and students prefer to use
47
+ <a href="https://ggplot2.tidyverse.org/ "
48
+ target="_ blank"><code >{ggplot2}</code ></a > and draw on their existing
49
+ skills rather than learn base R graphics just to visualize sequence
50
+ data.
49
51
50
52
[ ` {ggseqplot} ` ] ( https://maraab23.github.io/ggseqplot/ ) contains the
51
53
following functions:
@@ -54,39 +56,53 @@ following functions:
54
56
- ` ggseqeplot ` (equivalent to ` TraMineRextras::seqplot.tentrop ` )
55
57
- ` ggseqmsplot ` (equivalent to ` TraMineR::seqmsplot ` )
56
58
- ` ggseqmtplot ` (equivalent to ` TraMineR::seqmtplot ` )
57
- - ` ggstrqeplot ` (based on transitions rates computed with
58
- ` TraMineR::seqtrate ` )
59
+ - ` ggstrqeplot ` (based on transitions rates from ` TraMineR::seqtrate ` )
59
60
- ` ggseqiplot ` (equivalent to ` TraMineR::seqIplot ` )
60
61
- ` ggseqfplot ` (equivalent to ` TraMineR::seqfplot ` )
61
62
- ` ggseqrplot ` (equivalent to ` TraMineR::seqrplot ` )
62
63
- ` ggseqrfplot ` (equivalent to ` TraMineRextras::seqplot.rf ` )
63
64
64
- If you have change requests or find errors, [ create an
65
- issue] ( https://github.com/maraab23/ggseqplot/issues/new ) on github or
66
- send me an
67
- [ email] ( mailto:marcel.raab@ifb.uni-bamberg.de?subject=ggseqplot%3A%20feature%20request ) .
68
-
69
65
A complementing
70
66
[ vignette] ( https://maraab23.github.io/ggseqplot/articles/ggseqplot.html )
71
67
outlines how [ ` {ggseqplot} ` ] ( https://maraab23.github.io/ggseqplot/ )
72
68
reshapes sequence data generated with <a href="http://traminer.unige.ch "
73
- target="_ blank"><code >{TraMineR}</code ></a > functions to visualize them
74
- using <a href="https://ggplot2.tidyverse.org/ "
75
- target="_ blank"><code >{ggplot2}</code ></a >. Moreover, it illustrates how
76
- to adjust the baseline output using familiar
69
+ target="_ blank"><code >{TraMineR}</code ></a > functions for visualization
70
+ with <a href="https://ggplot2.tidyverse.org/ "
71
+ target="_ blank"><code >{ggplot2}</code ></a >. It also shows how to
72
+ customize the plots using familiar
77
73
<a href="https://ggplot2.tidyverse.org/ "
78
- target="_ blank"><code >{ggplot2}</code ></a > functions (and add-ons).
74
+ target="_ blank"><code >{ggplot2}</code ></a > functions and extensions.
75
+
76
+ If you find errors or have feature requests, feel free to [ create an
77
+ issue] ( https://github.com/maraab23/ggseqplot/issues/new ) on GitHub or
78
+ send me an
79
+ [ email] ( mailto:marcel.raab@ifb.uni-bamberg.de?subject=ggseqplot%3A%20feature%20request ) .
80
+
81
+ ## Citation
82
+
83
+ If you use [ ` {ggseqplot} ` ] ( https://cran.r-project.org/package=ggseqplot )
84
+ in your work, please cite it as:
85
+
86
+ > Raab, M. (2022). * ggseqplot: Render Sequence Plots using ‘ggplot2’* .
87
+ > < https://doi.org/10.32614/CRAN.package.ggseqplot >
88
+
89
+ You can also retrieve the citation in R with:
90
+
91
+ ``` r
92
+ citation(" ggseqplot" )
93
+ ```
79
94
80
95
## Installation
81
96
82
97
You can install the CRAN version of
83
- [ ` {ggseqplot} ` ] ( https://maraab23.github.io/ggseqplot/ ) by typing :
98
+ [ ` {ggseqplot} ` ] ( https://maraab23.github.io/ggseqplot/ ) with :
84
99
85
100
``` r
86
101
install.packages(" ggseqplot" )
87
102
```
88
103
89
- The development version can be installed with:
104
+ If a more recent version is available, you can install the development
105
+ version from GitHub with:
90
106
91
107
``` r
92
108
devtools :: install_github(" maraab23/ggseqplot" )
@@ -95,4 +111,5 @@ devtools::install_github("maraab23/ggseqplot")
95
111
## Acknowledgements
96
112
97
113
I would like to thank Gilbert Ritschard, Tim Liao, and Emanuela
98
- Struffolino for their comments on earlier versions of this library.
114
+ Struffolino for their helpful comments on earlier versions of this
115
+ library.
0 commit comments