Data

Tools

Indexes

Applications

Experiments

Open Source Science

https://github.com/calderonsamuel/reportesapi

Administra Base de Datos de Reportes

https://github.com/calderonsamuel/reportesapi

Science Score: 13.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
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (14.8%) to scientific vocabulary
Last synced: 10 months ago · JSON representation

Repository

Administra Base de Datos de Reportes

Basic Info
Statistics
  • Stars: 0
  • Watchers: 1
  • Forks: 0
  • Open Issues: 2
  • Releases: 15
Created over 3 years ago · Last pushed over 3 years 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%"
)
```

# reportesAPI


[![CRAN status](https://www.r-pkg.org/badges/version/reportesAPI)](https://CRAN.R-project.org/package=reportesAPI)
[![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental)
[![R-CMD-check](https://github.com/calderonsamuel/reportesAPI/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/calderonsamuel/reportesAPI/actions/workflows/R-CMD-check.yaml)
[![Codecov test coverage](https://codecov.io/gh/calderonsamuel/reportesAPI/branch/main/graph/badge.svg)](https://app.codecov.io/gh/calderonsamuel/reportesAPI?branch=main)


The goal of reportesAPI is to be able to get data from a Reportes instance for use in the app or in analysis.

The user should also have an `.Renviron` file containing the following variables:

- `DB_HOST`
- `DB_NAME`
- `DB_USER`
- `DB_SECRET`
- `DB_PORT`
- `REPORTES_EMAIL` (Optional)

The package asumes you are using RMariaDB for data storage.

## Installation

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

``` r
# install.packages("remotes")
remotes::install_github("calderonsamuel/reportesAPI")
```

## Example

This is a basic example which shows you how to solve a common problem:

```{r example}
library(reportesAPI)

man <- DBManager$new()
```

When fetching data, instead of returning a data.frame, by default we get a tibble.

```{r cars}
man$db_get_query("SELECT user_id, time_last_modified FROM users")
```

To start an instance of `AppData` is necessary to provide an email. This will not be done here for security reasons.

Owner

  • Name: Samuel Calderon
  • Login: calderonsamuel
  • Kind: user
  • Location: Lima

Peruvian political scientist

GitHub Events

Total
Last Year

Issues and Pull Requests

Last synced: over 1 year ago

All Time
  • Total issues: 15
  • Total pull requests: 0
  • Average time to close issues: 9 days
  • Average time to close pull requests: N/A
  • Total issue authors: 1
  • Total pull request authors: 0
  • Average comments per issue: 0.47
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • 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
  • calderonsamuel (10)
Pull Request Authors
Top Labels
Issue Labels
enhancement (3) bug (2)
Pull Request Labels

Dependencies

DESCRIPTION cran
  • DBI * imports
  • R6 * imports
  • RMariaDB * imports
  • cli * imports
  • glue * imports
  • ids * imports
  • lubridate * imports
  • purrr * imports
  • rlang * imports
  • tibble * imports
  • covr * suggests
.github/workflows/R-CMD-check.yaml actions
  • actions/checkout v3 composite
  • r-lib/actions/check-r-package v2 composite
  • r-lib/actions/setup-pandoc v2 composite
  • r-lib/actions/setup-r v2 composite
  • r-lib/actions/setup-r-dependencies v2 composite
.github/workflows/pkgdown.yaml actions
  • JamesIves/github-pages-deploy-action v4.4.1 composite
  • actions/checkout v3 composite
  • r-lib/actions/setup-pandoc v2 composite
  • r-lib/actions/setup-r v2 composite
  • r-lib/actions/setup-r-dependencies v2 composite
.github/workflows/test-coverage.yaml actions
  • actions/checkout v3 composite
  • actions/upload-artifact v3 composite
  • r-lib/actions/setup-r v2 composite
  • r-lib/actions/setup-r-dependencies v2 composite