Science Score: 44.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
-
○Academic publication links
-
○Academic email domains
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (18.3%) to scientific vocabulary
Keywords
api
epidemiology
health
rstats
sus
Last synced: 4 months ago
·
JSON representation
·
Repository
⚕️ An interface to openDataSUS in R
Basic Info
- Host: GitHub
- Owner: danielvartan
- License: other
- Language: R
- Default Branch: main
- Homepage: https://danielvartan.github.io/opendatasus/
- Size: 95.7 KB
Statistics
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
- Releases: 0
Archived
Topics
api
epidemiology
health
rstats
sus
Created over 1 year ago
· Last pushed over 1 year ago
Metadata Files
Readme
Changelog
Contributing
Funding
License
Code of conduct
Citation
Codemeta
README.Rmd
---
output: github_document
---
```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
library(opendatasus)
```
# opendatasus
[](https://www.repostatus.org/#wip)
[](https://lifecycle.r-lib.org/articles/stages.html#experimental)
[](https://github.com/danielvartan/opendatasus/actions)
[](https://app.codecov.io/gh/danielvartan/opendatasus?branch=main)
[](https://choosealicense.com/licenses/mit/)
[](https://danielvartan.github.io/opendatasus/CODE_OF_CONDUCT.html)
## Overview
`opendatasus` is an user-friendly R package designed for downloading and processing data from the [DATASUS](https://datasus.saude.gov.br/)'s [openDataSUS platform](https://opendatasus.saude.gov.br).
It is important to be aware of the limitations of the APIs you are using. Many APIs have limitations regarding the amount of data and number of requests that can be made in a given period of time. Therefore, this package may not serve as a solution for large-scale data extraction.
To access [DATASUS](https://datasus.saude.gov.br/)'s data not indexed on the [openDataSUS platform](https://opendatasus.saude.gov.br), check out Saldanha, Bastos & Barcellos's [`microdatasus`](https://github.com/rfsaldanha/microdatasus) R package, the [DATASUS's file transfer](https://datasus.saude.gov.br/transferencia-de-arquivos/) & [DATASUS's TabNet system](https://datasus.saude.gov.br/informacoes-de-saude-tabnet/).
## Prerequisites
To use the main functions of `opendatasus`, some familiarity with the [R programming language](https://www.r-project.org/) is required.
If you are not comfortable with R, we strongly recommend checking out Hadley Wickham and Garrett Grolemund's free online book [R for Data Science](https://r4ds.hadley.nz/), as well as the Coursera course [Data Science: Foundations using R](https://www.coursera.org/specializations/data-science-foundations-r) from John Hopkins University.
## Installation
You can install `opendatasus` using:
``` {r, eval = FALSE}
# install.packages("remotes")
remotes::install_github("danielvartan/opendatasus")
```
## Usage
We're working on new API functions to make it easier to access the data available on the openDataSUS platform. You can find a list of available functions [here](https://danielvartan.github.io/opendatasus/reference/index.html).
Example of use:
```{r}
library(opendatasus)
fetch_demas_sisvan(uf = "SP") |> dplyr::glimpse()
```
## Citation
If you use `opendatasus` in your research, please consider citing it. We have put a lot of work into building and maintaining this free and open-source R package. The citation can be found below.
```{r}
citation("opendatasus")
```
## Contributing
We welcome contributions, including bug reports.
Please take a moment to review our [Guidelines for Contributing](https://danielvartan.github.io/opendatasus/CONTRIBUTING.html).
Become a supporter of `opendatasus`!
Click [here](https://github.com/sponsors/danielvartan) to make a donation. Please indicate the `opendatasus` package in your donation message.
Owner
- Name: Daniel Vartanian
- Login: danielvartan
- Kind: user
- Location: São Paulo, Brazil
- Company: @sustentarea
- Website: danielvartan.com
- Repositories: 84
- Profile: https://github.com/danielvartan
Academic. Passionate about #opendata and #openscience.
Citation (CITATION.cff)
# --------------------------------------------
# CITATION file created with {cffr} R package
# See also: https://docs.ropensci.org/cffr/
# --------------------------------------------
cff-version: 1.2.0
message: 'To cite package "opendatasus" in publications use:'
type: software
license: MIT
title: 'opendatasus: Access openDataSUS APIs in R'
version: 0.0.1.9000
abstract: opendatasus is a user-friendly R package designed for downloading and processing
data from the DATASUS's openDataSUS platform.
authors:
- family-names: Vartanian
given-names: Daniel
email: danvartan@gmail.com
orcid: https://orcid.org/0000-0001-7782-759X
preferred-citation:
type: unpublished
title: 'opendatasus: Access openDataSUS APIs in R'
authors:
- family-names: Vartanian
given-names: Daniel
email: danvartan@gmail.com
orcid: https://orcid.org/0000-0001-7782-759X
year: '2024'
url: https://danielvartan.github.io/opendatasus/
notes: R package version 0.3.0.9000
repository-code: https://github.com/danielvartan/opendatasus/issues/
url: https://danielvartan.github.io/opendatasus/
contact:
- family-names: Vartanian
given-names: Daniel
email: danvartan@gmail.com
orcid: https://orcid.org/0000-0001-7782-759X
references:
- type: software
title: 'R: A Language and Environment for Statistical Computing'
notes: Depends
url: https://www.R-project.org/
authors:
- name: R Core Team
institution:
name: R Foundation for Statistical Computing
address: Vienna, Austria
year: '2024'
version: '>= 4.4'
- type: software
title: checkmate
abstract: 'checkmate: Fast and Versatile Argument Checks'
notes: Imports
url: https://mllg.github.io/checkmate/
repository: https://CRAN.R-project.org/package=checkmate
authors:
- family-names: Lang
given-names: Michel
email: michellang@gmail.com
orcid: https://orcid.org/0000-0001-9754-0393
year: '2024'
version: '>= 2.3.1'
- type: software
title: cli
abstract: 'cli: Helpers for Developing Command Line Interfaces'
notes: Imports
url: https://cli.r-lib.org
repository: https://CRAN.R-project.org/package=cli
authors:
- family-names: Csárdi
given-names: Gábor
email: csardi.gabor@gmail.com
year: '2024'
version: '>= 3.6.2'
- type: software
title: dplyr
abstract: 'dplyr: A Grammar of Data Manipulation'
notes: Imports
url: https://dplyr.tidyverse.org
repository: https://CRAN.R-project.org/package=dplyr
authors:
- family-names: Wickham
given-names: Hadley
email: hadley@posit.co
orcid: https://orcid.org/0000-0003-4757-117X
- family-names: François
given-names: Romain
orcid: https://orcid.org/0000-0002-2444-4226
- family-names: Henry
given-names: Lionel
- family-names: Müller
given-names: Kirill
orcid: https://orcid.org/0000-0002-1416-3412
- family-names: Vaughan
given-names: Davis
email: davis@posit.co
orcid: https://orcid.org/0000-0003-4777-038X
year: '2024'
version: '>= 1.1.4'
- type: software
title: jsonlite
abstract: 'jsonlite: A Simple and Robust JSON Parser and Generator for R'
notes: Imports
url: https://jeroen.r-universe.dev/jsonlite
repository: https://CRAN.R-project.org/package=jsonlite
authors:
- family-names: Ooms
given-names: Jeroen
email: jeroen@berkeley.edu
orcid: https://orcid.org/0000-0002-4035-0289
year: '2024'
version: '>= 1.8.8'
- type: software
title: httr
abstract: 'httr: Tools for Working with URLs and HTTP'
notes: Imports
url: https://httr.r-lib.org/
repository: https://CRAN.R-project.org/package=httr
authors:
- family-names: Wickham
given-names: Hadley
email: hadley@posit.co
year: '2024'
version: '>= 1.4.7'
- type: software
title: lifecycle
abstract: 'lifecycle: Manage the Life Cycle of your Package Functions'
notes: Imports
url: https://lifecycle.r-lib.org/
repository: https://CRAN.R-project.org/package=lifecycle
authors:
- family-names: Henry
given-names: Lionel
email: lionel@posit.co
- family-names: Wickham
given-names: Hadley
email: hadley@posit.co
orcid: https://orcid.org/0000-0003-4757-117X
year: '2024'
version: '>= 1.0.4'
- type: software
title: magrittr
abstract: 'magrittr: A Forward-Pipe Operator for R'
notes: Imports
url: https://magrittr.tidyverse.org
repository: https://CRAN.R-project.org/package=magrittr
authors:
- family-names: Bache
given-names: Stefan Milton
email: stefan@stefanbache.dk
- family-names: Wickham
given-names: Hadley
email: hadley@rstudio.com
year: '2024'
version: '>= 2.0.3'
- type: software
title: purrr
abstract: 'purrr: Functional Programming Tools'
notes: Imports
url: https://purrr.tidyverse.org/
repository: https://CRAN.R-project.org/package=purrr
authors:
- family-names: Wickham
given-names: Hadley
email: hadley@rstudio.com
orcid: https://orcid.org/0000-0003-4757-117X
- family-names: Henry
given-names: Lionel
email: lionel@rstudio.com
year: '2024'
version: '>= 1.0.2'
- type: software
title: rutils
abstract: 'rutils: Utility Functions for R'
notes: Imports
url: https://danielvartan.github.io/rutils/
authors:
- family-names: Vartanian
given-names: Daniel
email: danvartan@gmail.com
orcid: https://orcid.org/0000-0001-7782-759X
year: '2024'
- type: software
title: covr
abstract: 'covr: Test Coverage for Packages'
notes: Suggests
url: https://covr.r-lib.org
repository: https://CRAN.R-project.org/package=covr
authors:
- family-names: Hester
given-names: Jim
email: james.f.hester@gmail.com
year: '2024'
version: '>= 3.6.4'
- type: software
title: knitr
abstract: 'knitr: A General-Purpose Package for Dynamic Report Generation in R'
notes: Suggests
url: https://yihui.org/knitr/
repository: https://CRAN.R-project.org/package=knitr
authors:
- family-names: Xie
given-names: Yihui
email: xie@yihui.name
orcid: https://orcid.org/0000-0003-0645-5666
year: '2024'
version: '>= 1.47'
- type: software
title: mockr
abstract: 'mockr: Mocking in R'
notes: Suggests
url: https://krlmlr.github.io/mockr/
repository: https://CRAN.R-project.org/package=mockr
authors:
- family-names: Müller
given-names: Kirill
email: kirill@cynkra.com
year: '2024'
version: '>= 0.2.1'
- type: software
title: rmarkdown
abstract: 'rmarkdown: Dynamic Documents for R'
notes: Suggests
url: https://pkgs.rstudio.com/rmarkdown/
repository: https://CRAN.R-project.org/package=rmarkdown
authors:
- family-names: Allaire
given-names: JJ
email: jj@posit.co
- family-names: Xie
given-names: Yihui
email: xie@yihui.name
orcid: https://orcid.org/0000-0003-0645-5666
- family-names: Dervieux
given-names: Christophe
email: cderv@posit.co
orcid: https://orcid.org/0000-0003-4474-2498
- family-names: McPherson
given-names: Jonathan
email: jonathan@posit.co
- family-names: Luraschi
given-names: Javier
- family-names: Ushey
given-names: Kevin
email: kevin@posit.co
- family-names: Atkins
given-names: Aron
email: aron@posit.co
- family-names: Wickham
given-names: Hadley
email: hadley@posit.co
- family-names: Cheng
given-names: Joe
email: joe@posit.co
- family-names: Chang
given-names: Winston
email: winston@posit.co
- family-names: Iannone
given-names: Richard
email: rich@posit.co
orcid: https://orcid.org/0000-0003-3925-190X
year: '2024'
version: '>= 2.27'
- type: software
title: spelling
abstract: 'spelling: Tools for Spell Checking in R'
notes: Suggests
url: https://ropensci.r-universe.dev/spelling
repository: https://CRAN.R-project.org/package=spelling
authors:
- family-names: Ooms
given-names: Jeroen
email: jeroen@berkeley.edu
orcid: https://orcid.org/0000-0002-4035-0289
- family-names: Hester
given-names: Jim
email: james.hester@rstudio.com
year: '2024'
version: '>= 2.3.0'
- type: software
title: testthat
abstract: 'testthat: Unit Testing for R'
notes: Suggests
url: https://testthat.r-lib.org
repository: https://CRAN.R-project.org/package=testthat
authors:
- family-names: Wickham
given-names: Hadley
email: hadley@posit.co
year: '2024'
version: '>= 3.2.1.1'
identifiers:
- type: url
value: https://github.com/danielvartan/opendatasus/
CodeMeta (codemeta.json)
{
"@context": "https://doi.org/10.5063/schema/codemeta-2.0",
"@type": "SoftwareSourceCode",
"identifier": "opendatasus",
"description": "opendatasus is a user-friendly R package designed for downloading and processing data from the DATASUS's openDataSUS platform.",
"name": "opendatasus: Access openDataSUS APIs in R",
"relatedLink": "https://danielvartan.github.io/opendatasus/",
"codeRepository": "https://github.com/danielvartan/opendatasus/",
"issueTracker": "https://github.com/danielvartan/opendatasus/issues/",
"license": "https://spdx.org/licenses/MIT",
"version": "0.0.1.9000",
"programmingLanguage": {
"@type": "ComputerLanguage",
"name": "R",
"url": "https://r-project.org"
},
"runtimePlatform": "R version 4.4.0 (2024-04-24 ucrt)",
"author": [
{
"@type": "Person",
"givenName": "Daniel",
"familyName": "Vartanian",
"email": "danvartan@gmail.com",
"@id": "https://orcid.org/0000-0001-7782-759X"
}
],
"copyrightHolder": [
{
"@type": "Person",
"givenName": "Daniel",
"familyName": "Vartanian",
"email": "danvartan@gmail.com",
"@id": "https://orcid.org/0000-0001-7782-759X"
}
],
"maintainer": [
{
"@type": "Person",
"givenName": "Daniel",
"familyName": "Vartanian",
"email": "danvartan@gmail.com",
"@id": "https://orcid.org/0000-0001-7782-759X"
}
],
"softwareSuggestions": [
{
"@type": "SoftwareApplication",
"identifier": "covr",
"name": "covr",
"version": ">= 3.6.4",
"provider": {
"@id": "https://cran.r-project.org",
"@type": "Organization",
"name": "Comprehensive R Archive Network (CRAN)",
"url": "https://cran.r-project.org"
},
"sameAs": "https://CRAN.R-project.org/package=covr"
},
{
"@type": "SoftwareApplication",
"identifier": "knitr",
"name": "knitr",
"version": ">= 1.47",
"provider": {
"@id": "https://cran.r-project.org",
"@type": "Organization",
"name": "Comprehensive R Archive Network (CRAN)",
"url": "https://cran.r-project.org"
},
"sameAs": "https://CRAN.R-project.org/package=knitr"
},
{
"@type": "SoftwareApplication",
"identifier": "mockr",
"name": "mockr",
"version": ">= 0.2.1",
"provider": {
"@id": "https://cran.r-project.org",
"@type": "Organization",
"name": "Comprehensive R Archive Network (CRAN)",
"url": "https://cran.r-project.org"
},
"sameAs": "https://CRAN.R-project.org/package=mockr"
},
{
"@type": "SoftwareApplication",
"identifier": "rmarkdown",
"name": "rmarkdown",
"version": ">= 2.27",
"provider": {
"@id": "https://cran.r-project.org",
"@type": "Organization",
"name": "Comprehensive R Archive Network (CRAN)",
"url": "https://cran.r-project.org"
},
"sameAs": "https://CRAN.R-project.org/package=rmarkdown"
},
{
"@type": "SoftwareApplication",
"identifier": "spelling",
"name": "spelling",
"version": ">= 2.3.0",
"provider": {
"@id": "https://cran.r-project.org",
"@type": "Organization",
"name": "Comprehensive R Archive Network (CRAN)",
"url": "https://cran.r-project.org"
},
"sameAs": "https://CRAN.R-project.org/package=spelling"
},
{
"@type": "SoftwareApplication",
"identifier": "testthat",
"name": "testthat",
"version": ">= 3.2.1.1",
"provider": {
"@id": "https://cran.r-project.org",
"@type": "Organization",
"name": "Comprehensive R Archive Network (CRAN)",
"url": "https://cran.r-project.org"
},
"sameAs": "https://CRAN.R-project.org/package=testthat"
}
],
"softwareRequirements": {
"1": {
"@type": "SoftwareApplication",
"identifier": "R",
"name": "R",
"version": ">= 4.4"
},
"2": {
"@type": "SoftwareApplication",
"identifier": "checkmate",
"name": "checkmate",
"version": ">= 2.3.1",
"provider": {
"@id": "https://cran.r-project.org",
"@type": "Organization",
"name": "Comprehensive R Archive Network (CRAN)",
"url": "https://cran.r-project.org"
},
"sameAs": "https://CRAN.R-project.org/package=checkmate"
},
"3": {
"@type": "SoftwareApplication",
"identifier": "cli",
"name": "cli",
"version": ">= 3.6.2",
"provider": {
"@id": "https://cran.r-project.org",
"@type": "Organization",
"name": "Comprehensive R Archive Network (CRAN)",
"url": "https://cran.r-project.org"
},
"sameAs": "https://CRAN.R-project.org/package=cli"
},
"4": {
"@type": "SoftwareApplication",
"identifier": "dplyr",
"name": "dplyr",
"version": ">= 1.1.4",
"provider": {
"@id": "https://cran.r-project.org",
"@type": "Organization",
"name": "Comprehensive R Archive Network (CRAN)",
"url": "https://cran.r-project.org"
},
"sameAs": "https://CRAN.R-project.org/package=dplyr"
},
"5": {
"@type": "SoftwareApplication",
"identifier": "jsonlite",
"name": "jsonlite",
"version": ">= 1.8.8",
"provider": {
"@id": "https://cran.r-project.org",
"@type": "Organization",
"name": "Comprehensive R Archive Network (CRAN)",
"url": "https://cran.r-project.org"
},
"sameAs": "https://CRAN.R-project.org/package=jsonlite"
},
"6": {
"@type": "SoftwareApplication",
"identifier": "httr",
"name": "httr",
"version": ">= 1.4.7",
"provider": {
"@id": "https://cran.r-project.org",
"@type": "Organization",
"name": "Comprehensive R Archive Network (CRAN)",
"url": "https://cran.r-project.org"
},
"sameAs": "https://CRAN.R-project.org/package=httr"
},
"7": {
"@type": "SoftwareApplication",
"identifier": "lifecycle",
"name": "lifecycle",
"version": ">= 1.0.4",
"provider": {
"@id": "https://cran.r-project.org",
"@type": "Organization",
"name": "Comprehensive R Archive Network (CRAN)",
"url": "https://cran.r-project.org"
},
"sameAs": "https://CRAN.R-project.org/package=lifecycle"
},
"8": {
"@type": "SoftwareApplication",
"identifier": "magrittr",
"name": "magrittr",
"version": ">= 2.0.3",
"provider": {
"@id": "https://cran.r-project.org",
"@type": "Organization",
"name": "Comprehensive R Archive Network (CRAN)",
"url": "https://cran.r-project.org"
},
"sameAs": "https://CRAN.R-project.org/package=magrittr"
},
"9": {
"@type": "SoftwareApplication",
"identifier": "purrr",
"name": "purrr",
"version": ">= 1.0.2",
"provider": {
"@id": "https://cran.r-project.org",
"@type": "Organization",
"name": "Comprehensive R Archive Network (CRAN)",
"url": "https://cran.r-project.org"
},
"sameAs": "https://CRAN.R-project.org/package=purrr"
},
"10": {
"@type": "SoftwareApplication",
"identifier": "rutils",
"name": "rutils",
"sameAs": "https://github.com/danielvartan/rutils"
},
"SystemRequirements": null
},
"fileSize": "14.674KB",
"citation": [
{
"@type": "CreativeWork",
"datePublished": "2024",
"author": [
{
"@type": "Person",
"givenName": "Daniel",
"familyName": "Vartanian",
"email": "danvartan@gmail.com",
"@id": "https://orcid.org/0000-0001-7782-759X"
}
],
"name": "{opendatasus}: Access openDataSUS APIs in R",
"url": "https://danielvartan.github.io/opendatasus/",
"description": "R package version 0.3.0.9000"
}
],
"releaseNotes": "https://github.com/danielvartan/opendatasus/blob/master/NEWS.md",
"contIntegration": [
"https://github.com/danielvartan/opendatasus/actions",
"https://app.codecov.io/gh/danielvartan/opendatasus?branch=main"
],
"developmentStatus": [
"https://www.repostatus.org/#wip",
"https://lifecycle.r-lib.org/articles/stages.html#experimental"
]
}GitHub Events
Total
- Watch event: 1
Last Year
- Watch event: 1
Issues and Pull Requests
Last synced: about 1 year ago
All Time
- Total issues: 0
- Total pull requests: 0
- Average time to close issues: N/A
- Average time to close pull requests: N/A
- Total issue authors: 0
- Total 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
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