highlightr

Highlight Text Based on Note Frequency

https://github.com/rachelesrogers/highlightr

Science Score: 26.0%

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

○
CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
✓
.zenodo.json file
Found .zenodo.json file
○
DOI references
○
Academic publication links
○
Academic email domains
○
Institutional organization owner
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (14.7%) to scientific vocabulary

Last synced: 9 months ago · JSON representation

Repository

Highlight Text Based on Note Frequency

Basic Info

Host: GitHub
Owner: rachelesrogers
License: other
Language: R
Default Branch: main
Homepage: https://rachelesrogers.github.io/highlightr/
Size: 6.29 MB

Statistics

Stars: 1
Watchers: 1
Forks: 0
Open Issues: 0
Releases: 0

Created almost 3 years ago · Last pushed 12 months ago

Metadata Files

Readme Changelog License

README.Rmd

---
output: github_document
---

# highlightr 




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




This package can be used to create a highlighted source document based on the frequency of phrases found in single or multiple note sheets.
The goal of this method is to indicate the portions of the source document that individuals felt was most worth copying into notes, based on phrase frequency.
The inputs necessary for this procedure are a notes document and a source document.
The output will be HTML code for generating the highlighted text.

## Acknowledgements

This work was funded (or partially funded) by the Center for Statistics and Applications in Forensic Evidence (CSAFE) 
through Cooperative Agreements 70NANB15H176 and 70NANB20H019 between NIST and Iowa State University, which includes activities carried 
out at Carnegie Mellon University, Duke University, University of California Irvine, University of Virginia, West Virginia University, 
University of Pennsylvania, Swarthmore College and University of Nebraska, Lincoln.

## Installation

You can install from CRAN with:

``` r
install.packages("highlightr")
```

You can install the development version of highlightr from [GitHub](https://github.com/) with:

``` r
# install.packages("devtools")
devtools::install_github("rachelesrogers/highlightr")
```


## Example

```{r, message=FALSE}
library(highlightr)
comment_example_rename <- dplyr::rename(comment_example, page_notes=Notes)
toks_comment <- token_comments(comment_example_rename)
transcript_example_rename <- dplyr::rename(transcript_example, text=Text)
toks_transcript <- token_transcript(transcript_example_rename)
collocation_object <- collocate_comments_fuzzy(toks_transcript, toks_comment)
merged_frequency <- transcript_frequency(transcript_example_rename, collocation_object)
freq_plot <- collocation_plot(merged_frequency)
page_highlight <- highlighted_text(freq_plot)

```

```{r results='asis', eval=FALSE}
page_highlight
```
`page_highlight` will produce HTML output that can then be rendered into highlighted text.
This can be done in R Markdown by specifying the object outside of a code chunk as `` `r '\x60r page_highlight\x60'` ``, and knitting the document to HTML.

The below image is generated through the resulting html output (as seen in the `vignette("highlightr")`).

Owner

Name: Rachel Rogers
Login: rachelesrogers
Kind: user
Company: University of Nebraska-Lincoln

Repositories: 1
Profile: https://github.com/rachelesrogers

Graduate Student

GitHub Events

Total

Create event: 2
Release event: 2
Issues event: 6
Push event: 50

Last Year

Create event: 2
Release event: 2
Issues event: 6
Push event: 50

Issues and Pull Requests

Last synced: 10 months ago

All Time

Total issues: 6
Total pull requests: 0
Average time to close issues: 12 days
Average time to close pull requests: N/A
Total issue authors: 2
Total pull request authors: 0
Average comments per issue: 0.17
Average comments per pull request: 0
Merged pull requests: 0
Bot issues: 0
Bot pull requests: 0

Past Year

Issues: 4
Pull requests: 0
Average time to close issues: 3 days
Average time to close pull requests: N/A
Issue authors: 1
Pull request authors: 0
Average comments per issue: 0.0
Average comments per pull request: 0
Merged pull requests: 0
Bot issues: 0
Bot pull requests: 0

View more stats

Top Authors

Issue Authors

rachelesrogers (5)
brichard1638 (1)

Pull Request Authors

Top Labels

Issue Labels

Pull Request Labels

Packages

Total packages: 1
Total downloads:
- cran 139 last-month

Total dependent packages: 0
Total dependent repositories: 0
Total versions: 3
Total maintainers: 1

cran.r-project.org: highlightr

Highlight Conserved Edits Across Versions of a Document

Homepage: https://rachelesrogers.github.io/highlightr/
Documentation: http://cran.r-project.org/web/packages/highlightr/highlightr.pdf
License: MIT + file LICENSE
Latest release: 1.1.2
published 12 months ago

Versions: 3
Dependent Packages: 0
Dependent Repositories: 0
Downloads: 139 Last month

Rankings

Dependent packages count: 28.5%

Dependent repos count: 35.1%

Average: 50.1%

Downloads: 86.8%

Maintainers (1)

rrogers.rpackages@gmail.com