Data

Tools

Indexes

Applications

Experiments

Open Source Science

avert_report

Initial shell of a reporting template to summarise output from the avert computational model

https://github.com/avertableburden/avert_report

Science Score: 67.0%

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

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ✓
    DOI references
    Found 3 DOI reference(s) in README
  • ✓
    Academic publication links
    Links to: zenodo.org
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (7.4%) to scientific vocabulary
Last synced: 10 months ago · JSON representation ·

Repository

Initial shell of a reporting template to summarise output from the avert computational model

Basic Info
  • Host: GitHub
  • Owner: avertableburden
  • License: gpl-3.0
  • Language: Lua
  • Default Branch: main
  • Size: 512 KB
Statistics
  • Stars: 0
  • Watchers: 1
  • Forks: 0
  • Open Issues: 0
  • Releases: 3
Created over 1 year ago · Last pushed over 1 year ago
Metadata Files
Readme License Citation

README.md

avert_report: Generate a report from the avert computational model

DOI

This is the shell of a reporting template to be used in conjunction with the avert computational model.

This reporting template is designed for use in conjunction with the avert R library. You can install avert with the following commands.

``` r utils::install.packages("remotes")

remotes::install_github("avertableburden/avert") ```

To render a report using the latest release of this template:

r library(avert) write_avert_report(get_input_data(), output_dir_1L_chr = tempdir())

Alternatively, if you clone this repository to your machine, you can render the latest development version of the template from within the parent directory of the cloned repository:

r library(avert) write_avert_report(get_input_data(), mkdn_source_dir_1L_chr = getwd(), output_dir_1L_chr = "Tests")

An example of a PDF report produced with the above calls is available for download here.

Owner

  • Name: avertableburden
  • Login: avertableburden
  • Kind: organization

Citation (CITATION.cff) 

cff-version: 1.2.0
message: "Hamilton, Matthew. (2024). avert_report: Generate a report from the avert computational model. Zenodo. https://doi.org/10.5281/zenodo.14279401"
authors:
  - family-names: "Hamilton"
    given-names: "Matthew"
    orcid: https://orcid.org/0000-0001-7407-9194
title: "avert_report: Generate a report from the avert computational model"
version: 0.1.2
doi: 10.5281/zenodo.14279401
date-released: 2024-12-03
url: "https://github.com/avertableburden/avert_report"

GitHub Events

Total
  • Release event: 3
  • Push event: 7
  • Create event: 3
Last Year
  • Release event: 3
  • Push event: 7
  • Create event: 3