htmlreportR

HTML reporting made simple(R)

https://github.com/aestebanmar/htmlreportr

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.2%) to scientific vocabulary

Keywords

css html js r reporting-tool

Last synced: 6 months ago · JSON representation

Repository

HTML reporting made simple(R)

Basic Info

Host: GitHub
Owner: AEstebanMar
License: gpl-3.0
Language: CSS
Default Branch: master
Homepage:
Size: 5.27 MB

Statistics

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

Topics

css html js r reporting-tool

Created about 2 years ago · Last pushed 7 months ago

Metadata Files

Readme Changelog License

README.Rmd

---
output: github_document
---



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

# htmlreportR


[![R-CMD-check](https://github.com/AEstebanMar/htmlreportR/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/AEstebanMar/htmlreportR/actions/workflows/R-CMD-check.yaml)


htmlreportR has not been built from scratch. It is based on its Python equivalent and sister project, available at  for a Python equivalent.

## Installation

Standard installation:

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

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

``` r
# install.packages("devtools")
devtools::install_github("AEstebanMar/htmlreportR")
```

## Example

There are two use cases for htmlreportR: script mode and package mode.

### Script mode

Simply call the html_report.R script, distributed with this package. Simply
provide a comma-separated list of files and a template to render, and you're done!


```{r script_example, engine = 'bash', eval = FALSE}
./scripts/html_report.R -d data1.txt,data2.txt -t template.txt
```

### Library mode

If you wish to use htmlreportR directly from R, you can! Here's how:
```{r library_example, eval = FALSE}
library(htmlreportR)
container <- list(data1 = data_frame_1, data2 = data_frame_2,
                  additional_field = "You can include anything in the container
                  and it will be available in plotter$hash_vars")
plotter <- htmlReport$new(title_doc = "Your report title", 
                          container = container, tmp_folder = "tmp_lib",
                          src = "path/to/htmlreportR/scripts")
```

Owner

Name: Álvaro Esteban Martos
Login: AEstebanMar
Kind: user
Location: Facultad de Ciencias, Málaga
Company: Universidad de Málaga

Twitter: elsociobq
Repositories: 1
Profile: https://github.com/AEstebanMar

Rookie bioinformatician at Universidad de Málaga

GitHub Events

Total

Delete event: 1
Push event: 46
Create event: 2

Last Year

Delete event: 1
Push event: 46
Create event: 2

Issues and Pull Requests

Last synced: 6 months ago

All Time

Total issues: 1
Total pull requests: 1
Average time to close issues: about 2 months
Average time to close pull requests: less than a minute
Total issue authors: 1
Total pull request authors: 1
Average comments per issue: 1.0
Average comments per pull request: 0.0
Merged pull requests: 1
Bot issues: 0
Bot pull requests: 0

Past Year

Issues: 0
Pull requests: 0
Average time to close issues: N/A
Average time to close pull requests: N/A
Issue authors: 0
Pull request authors: 0
Average comments per issue: 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

AEstebanMar (1)

Pull Request Authors

AEstebanMar (1)

Top Labels

Issue Labels

Pull Request Labels

Packages

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

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

cran.r-project.org: htmlreportR

'HTML' Reporting Made Simple(R)

Homepage: https://github.com/AEstebanMar/htmlreportR
Documentation: http://cran.r-project.org/web/packages/htmlreportR/htmlreportR.pdf
License: GPL (≥ 3)
Latest release: 1.0.0
published over 1 year ago

Versions: 1
Dependent Packages: 0
Dependent Repositories: 0
Downloads: 164 Last month

Rankings

Dependent packages count: 28.4%

Dependent repos count: 35.0%

Average: 50.1%

Downloads: 86.8%

Maintainers (1)

alvaroesteban@uma.es