rtext

R6 R text and data objects

https://github.com/petermeissner/rtext

Repository

R6 R text and data objects

README.Rmd

---
output: github_document
---





**Status**


[![Travis-CI Build Status](https://api.travis-ci.com/petermeissner/rtext.svg?branch=master)](https://www.travis-ci.com/github/petermeissner/rtext)
[![AppVeyor build status](https://ci.appveyor.com/api/projects/status/github/petermeissner/rtext?branch=master&svg=true)](https://ci.appveyor.com/project/petermeissner/rtext)
[![codecov](https://codecov.io/gh/petermeissner/rtext/branch/master/graph/badge.svg)](https://codecov.io/gh/petermeissner/rtext/tree/master/R)
[![CRAN version](https://www.r-pkg.org/badges/version/rtext)](https://cran.r-project.org/package=rtext)
![CRAN downloads](https://cranlogs.r-pkg.org/badges/grand-total/rtext)
![CRAN downloads](https://cranlogs.r-pkg.org/badges/rtext)



```{r, include=FALSE, cache=FALSE}
options("width"=108)
pkg  <- basename(getwd())
tmp  <- packageDescription(pkg)
date <- max(as.Date(file.info(list.files("r_package/R/", full.names = TRUE))$mtime) )
```

```{r, results='asis', echo=FALSE}
cat("#", tmp$Title)
```






**Version**

```{r, results='asis', echo=FALSE}
cat(tmp$Version, "
\n", as.character(date))
cat(" (last change to R folder)")
```





**Description**

```{r, results='asis', echo=FALSE}
cat(tmp$Description)
```





**Funding**

This software was created as part of the "Institutional Design in Western European Democracies" research project, funded by [DFG (Deutsche Forschungsgemeinschaft)](https://gepris.dfg.de/gepris/projekt/146229116), lead by [Ulrich Sieberer](https://scholar.google.com/citations?user=Q_ImhbkAAAAJ) and based at [University Konstanz](https://www.uni-konstanz.de/). 




**License**

```{r, results='asis', echo=FALSE}
cat(tmp$License, "
")
cat(tmp$Author)
```





**Citation**


```{r, results='asis', echo=FALSE}
citation(pkg)
```




**BibTex for citing**


```{r, results='asis', echo=FALSE}
toBibtex(citation(pkg))
```







**Installation**

stable CRAN version

```{r, eval=FALSE}
install.packages("rtext")
library(rtext)
```









**Package Contents**


```{r}
library(rtext)
objects("package:rtext")
```








**Contribution**

Note, that this package uses a Contributor Code of Conduct. By participating in this project you agree to abide by its terms: https://contributor-covenant.org/version/1/0/0/ (basically this should be a place were people get along with each other respectful and nice because it's simply more fun that way for everybody)


Contributions are very much welcome, e.g. in the form of:

- **typo fixing** ([edit file directly on Github](https://help.github.com/articles/editing-files-in-another-user-s-repository/))
- **bug reporting** (file an [issue](https://guides.github.com/features/issues/) - after having searched if the issue came up before - as - if possible - [minimal reproducable example](https://stackoverflow.com/help/mcve))
- **extending help files** (e.g. [edit the respective files directly on Github](https://help.github.com/articles/editing-files-in-another-user-s-repository/) or [fork the package](https://help.github.com/articles/fork-a-repo/) and later on make a [pull request](https://help.github.com/articles/using-pull-requests/); note, that the package use [roxygen2](https://r-pkgs.org/man.html) for easing documentation)
- **writing example** (e.g. [edit the respective files directly on Github](https://help.github.com/articles/editing-files-in-another-user-s-repository/) or [fork the package](https://help.github.com/articles/fork-a-repo/) and later on make a [pull request](https://help.github.com/articles/using-pull-requests/); note, that the package use [roxygen2](https://r-pkgs.org/man.html) for easing documentation)
- **vignette writing** (file an [issue](https://guides.github.com/features/issues/) first so that we can discuss htings than [fork the package](https://help.github.com/articles/fork-a-repo/) and later on make a [pull request](https://help.github.com/articles/using-pull-requests/))
- **test writing** (have a look at the [test coverage](https://codecov.io/gh/petermeissner/rtext/tree/master/R) than [fork the package](https://help.github.com/articles/fork-a-repo/) and later on make a [pull request](https://help.github.com/articles/using-pull-requests/))
- **feature suggestions** (file an [issue](https://guides.github.com/features/issues/) describing the idea, why this is important, possible alternative solutions and an example)
- **general discussion** of approach and or implementation  (file an [issue](https://guides.github.com/features/issues/))
- implementation **improvements** (file an [issue](https://guides.github.com/features/issues/) naming whats to be improved, why and how)

    




**Example Usage**




*... starting up ...*

```{r}
library(rtext)
```




*... creating a text object ...*
```{r}
# initialize (with text or file)
quote_text <- "Outside of a dog, a book is man's best friend. Inside of a dog it's too dark to read."
quote <- rtext$new(text = quote_text)
```



*... setting and getting data ...*
```{r}
# add some data
quote$char_data_set("first", 1, TRUE)
quote$char_data_set("last", quote$char_length(), TRUE)

# get the data
quote$char_data_get()
```




*... text transformation and data update ...*
```{r}
# transform text
quote$char_add("[this is an insertion] \n", 47)

# get the data again (see, the data moved along with the text)
quote$text_get()
quote$char_data_get()
```




*... using regular expression for setting data ...*
```{r}
# do some convenience coding (via regular expressions)
quote$char_data_set_regex("dog_friend", "dog", "dog")
quote$char_data_set_regex("dog_friend", "friend", "friend")
quote$char_data_get()
```



*... data aggregation via regex ...*
```{r}
quote$tokenize_data_regex(split="(dog)|(friend)", non_token = TRUE, join = "full")
```



*... data aggregation by words ...*
```{r}
quote$tokenize_data_words(non_token = TRUE, join="full")
```



*... data aggregation by lines ...*
```{r}
quote$tokenize_data_lines()
```

   


*... text plotting with data highlighting ...*
```{r, eval=FALSE}
plot(quote, "dog_friend")
```

![plot 1](https://raw.githubusercontent.com/petermeissner/rtext/master/README_files/figure-markdown_github/unnamed-chunk-19-1.png)

    
    


*... adding further data to the plot ...*
```{r, eval=FALSE}
plot(quote, "dog_friend")
plot(quote, "first", col="steelblue", add=TRUE)
plot(quote, "last", col="steelblue", add=TRUE)
```

![plot 2](https://raw.githubusercontent.com/petermeissner/rtext/master/README_files/figure-markdown_github/unnamed-chunk-20-1.png)

Owner

GitHub Events

Committers

Last synced: over 3 years ago

Packages