Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
stephenturner committed Aug 22, 2024
1 parent c35dfbf commit 161f4dd
Show file tree
Hide file tree
Showing 16 changed files with 37 additions and 2 deletions.
2 changes: 2 additions & 0 deletions .Rbuildignore
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,5 @@ biorecap-report-.*\.html
^pkgdown$
^\.github$
^CITATION\.cff$
.*\.drawio
.*\.drawio\.bkp
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,5 @@ scratch.R
**skeleton*.html
biorecap-report*.html
docs
*.drawio.bkp
*.drawio.dtmp
6 changes: 5 additions & 1 deletion README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -20,14 +20,18 @@ knitr::opts_chunk$set(
)
```

# biorecap
# biorecap <a href='https://github.com/stephenturner/biorecap'><img src='man/figures/logo.png' align="right" height="250" /></a>

<!-- badges: start -->
[![R-CMD-check](https://github.com/stephenturner/biorecap/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/stephenturner/biorecap/actions/workflows/R-CMD-check.yaml)
[![arXiv](https://img.shields.io/badge/DOI-10.48550/arXiv.2408.11707-AD1429)](https://doi.org/10.48550/arXiv.2408.11707)
![biorecap-r-universe](https://stephenturner.r-universe.dev/badges/biorecap)
<!-- badges: end -->

Retrieve and summarize [bioRxiv](https://www.biorxiv.org/) preprints using a local LLM with [Ollama](https://ollama.com/) via [ollamar](https://cran.r-project.org/package=ollamar).

Turner, S. D. (2024). biorecap: an R package for summarizing bioRxiv preprints with a local LLM. _arXiv_, 2408.11707. https://doi.org/10.48550/arXiv.2408.11707.

## Installation

Install biorecap from GitHub (keep `dependencies=TRUE` to get Suggests packages needed to create the HTML report):
Expand Down
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,23 @@

<!-- README.md is generated from README.Rmd. Please edit that file -->

# biorecap
# biorecap <a href='https://github.com/stephenturner/biorecap'><img src='man/figures/logo.png' align="right" height="250" /></a>

<!-- badges: start -->

[![R-CMD-check](https://github.com/stephenturner/biorecap/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/stephenturner/biorecap/actions/workflows/R-CMD-check.yaml)
[![arXiv](https://img.shields.io/badge/DOI-10.48550/arXiv.2408.11707-AD1429)](https://doi.org/10.48550/arXiv.2408.11707)
![biorecap-r-universe](https://stephenturner.r-universe.dev/badges/biorecap)
<!-- badges: end -->

Retrieve and summarize [bioRxiv](https://www.biorxiv.org/) preprints
using a local LLM with [Ollama](https://ollama.com/) via
[ollamar](https://cran.r-project.org/package=ollamar).

Turner, S. D. (2024). biorecap: an R package for summarizing bioRxiv
preprints with a local LLM. *arXiv*, 2408.11707.
<https://doi.org/10.48550/arXiv.2408.11707>.

## Installation

Install biorecap from GitHub (keep `dependencies=TRUE` to get Suggests
Expand Down
2 changes: 2 additions & 0 deletions man/biorecap-package.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

19 changes: 19 additions & 0 deletions man/figures/logo.drawio
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
<mxfile host="Electron" modified="2024-08-20T18:43:07.249Z" agent="Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) draw.io/21.2.8 Chrome/112.0.5615.165 Electron/24.2.0 Safari/537.36" etag="XVmYS9NQGfzw-8uo_49m" version="21.2.8" type="device">
<diagram name="Page-1" id="aF_57w-li47PTJFq52kK">
<mxGraphModel dx="106" dy="109" grid="1" gridSize="10" guides="1" tooltips="1" connect="1" arrows="1" fold="1" page="1" pageScale="1" pageWidth="174" pageHeight="200" math="0" shadow="0">
<root>
<mxCell id="0" />
<mxCell id="1" parent="0" />
<mxCell id="4GjIQkiC3v3QUifNR8dl-6" value="" style="shape=hexagon;perimeter=hexagonPerimeter2;whiteSpace=wrap;html=1;fixedSize=1;direction=south;strokeWidth=5;aspect=fixed;size=48.440677966101646;fillColor=#d6ebff;strokeColor=#000000;" vertex="1" parent="1">
<mxGeometry x="176" y="203" width="169.5" height="194.25" as="geometry" />
</mxCell>
<mxCell id="4GjIQkiC3v3QUifNR8dl-1" value="&lt;font style=&quot;font-size: 34px;&quot; face=&quot;Quadrat Serial&quot;&gt;bio&lt;font style=&quot;font-size: 34px;&quot; color=&quot;#a1212c&quot;&gt;R&lt;/font&gt;ecap&lt;/font&gt;" style="text;html=1;align=center;verticalAlign=middle;resizable=0;points=[];autosize=1;strokeColor=none;fillColor=none;fontSize=34;" vertex="1" parent="1">
<mxGeometry x="175.5" y="245" width="170" height="60" as="geometry" />
</mxCell>
<mxCell id="4GjIQkiC3v3QUifNR8dl-9" value="&lt;span style=&quot;font-size: 73px;&quot;&gt;🦙&lt;/span&gt;" style="text;html=1;strokeColor=none;fillColor=none;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;fontSize=73;" vertex="1" parent="1">
<mxGeometry x="200" y="280" width="121" height="110" as="geometry" />
</mxCell>
</root>
</mxGraphModel>
</diagram>
</mxfile>
Binary file added man/figures/logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added pkgdown/favicon/apple-touch-icon-120x120.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added pkgdown/favicon/apple-touch-icon-152x152.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added pkgdown/favicon/apple-touch-icon-180x180.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added pkgdown/favicon/apple-touch-icon-60x60.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added pkgdown/favicon/apple-touch-icon-76x76.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added pkgdown/favicon/apple-touch-icon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added pkgdown/favicon/favicon-16x16.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added pkgdown/favicon/favicon-32x32.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added pkgdown/favicon/favicon.ico
Binary file not shown.

0 comments on commit 161f4dd

Please sign in to comment.