R Observatory: Metrics for GetFREData version 1.1.0

Balamuta, James Joseph

doi:10.5281/zenodo.21843040

GetFREData

1.1.0Package record

Reading FRE Corporate Data of Public Traded Companies from B3

0packages depend

3.3Kdownloads / year

77.5%test coverage

13/13flavors OK

Overview

About

Maintained by Marcelo PerlinCRAN page ↗GitHub ↗Issues ↗

Reads corporate data such as board composition and compensation for companies traded at B3, the Brazilian exchange https://www.b3.com.br/. All data is downloaded and imported from the ftp site https://dados.cvm.gov.br/dados/CIA_ABERTA/DOC/FRE/.

Changes in 1.1.0

New features

Added companies_cvm_codes argument to get_fre_data2(), allowing users to filter results by one or more CVM company codes.
Cleaned table names in the output list by stripping the redundant fre_cia_aberta_ prefix (e.g. capital_social instead of cia_aberta_capital_social).
Added verbose logical parameter to get_fre_data2() to allow controlling or suppressing informative console output.
Added parsed RDS caching in cache_folder/parsed-rds/ so subsequent calls for previously parsed years load instantly from cached RDS files without re-unzipping or re-parsing CSVs.
Added comprehensive input validation to get_fre_data2(): type and range checks for first_year/last_year, verbose, a warning when requesting future years, and type checking for companies_cvm_codes.
Added _pkgdown.yml for website configuration and package-level documentation (?GetFREData).

Bug fixes & usability

Fixed a crash in the download helper where file.size() was called on a non-existent file after a failed download attempt.
Download failures now raise a clear error (cli::cli_abort()) instead of silently returning FALSE, which previously led to confusing downstream errors.
Suppressed readr's CSV reading progress and speed messages (progress = FALSE, suppressMessages()) during dataset parsing.

Breaking changes

Show all changes in 1.1.0Hide the rest of the changes in 1.1.0

Removed the accidentally exported my_fix_cols() function from the public API. This was an internal helper and should not have been exported.

Testing & Infrastructure

Expanded unit test coverage with offline tests for CSV parsing helpers (fix_single_name(), read_single_csv(), fix_df()), input validation, and deprecation stubs.
Updated GitHub Actions workflow to @v4 (actions/checkout@v4).
Resolved R CMD check NOTE regarding undefined global variable .data in filter_by_company(), reaching a clean Status: OK (0 ERRORS, 0 WARNINGS, 0 NOTES).

Code cleanup

Removed ~1,100 lines of dead code from the deprecated get_fre_data() XML pipeline: fcts_xml.R, fct_read_fre_zip_file.R, fct_get_fre_links.R, and fct_utils.R. The get_fre_data() function remains as a minimal deprecation stub pointing users to get_fre_data2().
Dropped XML and magrittr from package dependencies.
Migrated all remaining %>% (magrittr pipe) usage to the native R pipe (|>).

From NEWS.md in the release

Install

R (CRAN)pak (dev)Ubuntu (r2u)Fedora (COPR)openSUSE (OBS)

install.packages("GetFREData", repos = "https://cloud.r-project.org/")

Installs the current CRAN release. Prebuilt binaries on Windows and macOS.

if (!requireNamespace("pak", quietly = TRUE))
  install.packages("pak", repos = "https://cloud.r-project.org/")
pak::pak("msperlin/GetFREData")

Development version from msperlin/GetFREData. Installs pak first if it is not already available.

Release

# enable cranapt (r2u) if it is not already set up, then install
grep -rqs r2u.stat.illinois.edu /etc/apt/sources.list /etc/apt/sources.list.d/ \
  || curl -fsSL https://raw.githubusercontent.com/eddelbuettel/r2u/master/inst/scripts/add_cranapt_noble.sh | sudo bash
sudo apt install -y r-cran-getfredata

Fast Ubuntu binaries via r2u (no compilation). The cranapt setup runs once and is skipped when it is already enabled. We list this channel from recorded r2u download activity rather than from a live index of the repository, so treat it as last known rather than guaranteed.

bspm (used by r2u) also needs make: sudo apt install make

# enable the iucar/cran COPR if it is not already present, then install
ls /etc/yum.repos.d/*iucar*cran*.repo >/dev/null 2>&1 \
  || sudo dnf copr enable -y iucar/cran
sudo dnf install -y R-CRAN-GetFREData

RPMs from the iucar/cran COPR, rebuilt from CRAN.

For install.packages() integration in R, also: sudo dnf install R-CoprManager

# add the autoCRAN OBS repo (Tumbleweed) if it is missing, then install
zypper -q lr | grep -qi autoCRAN \
  || sudo zypper addrepo https://download.opensuse.org/repositories/devel:/languages:/R:/autoCRAN/openSUSE_Tumbleweed/devel:languages:R:autoCRAN.repo
sudo zypper install -y R-GetFREData

RPMs auto-built from CRAN on openSUSE OBS (Tumbleweed). We list this channel from recorded autoCRAN download activity rather than from a live index of the repository, so treat it as last known rather than guaranteed.

Health

CRAN checks

13OK

CRAN check page ↗

Slowest check: 1.2 min · r-oldrel-macos-x86_64

Status changes

OK13 OK2026-08-05
NOTE12 OK, 1 NOTE2026-08-01
OK13 OK2026-06-09
ERROR12 OK, 1 ERROR2026-06-08
OK14 OK2026-03-10

Advisories

none known

How this is measured·How advisories are found

Documentation

In release 1.1.0

READMEYes · 131 wordsVignettesYes · 1 · staticNEWSYes · 100% structured · mentions 1.1.0Citation fileNoWebsitenot declared in DESCRIPTION

Help pages: 6 (1 internal)includes a package overview page
Examples that run: 0%5 never run
Exported functions with examples: 100%
Documented parameters: 96%
Return-value docs: 100%
Help pages citing references: 0%

Vignettes (1)

Using GetFREData HTML

How these are measured

Downloads

3.3K

CRAN downloads in the past year

Rank #10,748 · ~9/day · ~273/mo

Releases R versions

Daily download trend is not available in this view yet.

28530 days

97790 days

3.3K1 year

Compare downloads with other packages →

Also on86 r2u4 autocran

How downloads are counted

Repository

msperlin/getfredata ↗Account: msperlin

5Stars

1Forks

0Open issues

0Open PRs

0Releases

33Commits

2Commit identities

33 commits · Last activity 2026-09-04 · 0% stars, 30d · Default branch at 1.2.0, ahead of CRAN 1.1.0 (checked 2026-10-21)

Responsiveness

How these are sampled

PRs merged (all time): 100%
Median days to close, 50 most recently updated closed issues: 3
Median days to close, 50 most recently updated closed PRs: 0

Stars over time

2023-02-01 · 52026-07-07 · 5

How these are measured

PracticesBeta

6 development-tooling and community-health practices detected across 5 families in the upstream repository

Checks run against github.com/msperlin/getfredata on 2026-10-21.

Continuous integration (2)

GitHub ActionsR CMD check workflow

The R CMD check workflow runs on Linux, macOS and Windows, and on R-devel

Governance and community (1)

The repository owner accepts GitHub Sponsors

Docs source (1)

pkgdown

CRAN release process (1)

CRAN-SUBMISSION

Show all practicesHide 1 practice

Lint, format, editor (1)

RStudio project

How this is detected·Detection ruleset v4 (2026-10-20)

Dependencies

Declared dependencies

17 external dependencies (excludes base and recommended)

Installing GetFREData adds 69 packages (42 with compiled code, 48 MB of source tarballs). Heaviest: stringi 11 MB, bslib 5.6 MB, promises 3.1 MB.

Depends (1)

R >= 4.1.0

Imports (14)

stringr xml2 dplyr readr lubridate purrr rvest GetDFPData2utilscli fs glue janitor lifecycle

LinkingTo (0)

none

Suggests (4)

knitr rmarkdown testthat ggplot2

Enhances (0)

none

Dependency license breakdown →

Reverse dependencies

0direct

0indirect

Nothing depends on this yet.

How these are counted

Code & Tests

People & History

People (2)

Marcelo Perlin

Author, Maintainer since 0.6 (2021)

Guilherme Kirch

Author

Releases (5)

Pick two releases to compare their code metrics.

1.1.0Latest
record
2026-08-29 · current release · diff ↗ ·
removed 1 export
my_fix_cols
1.0.1
record
2026-06-03 · diff ↗ ·
added 2 exports
clean_fre_cache, get_fre_data2
R
R 4.6.0 released · 2026-04-24
R
R 4.5.0 released · 2025-04-11
R
R 4.4.0 released · 2024-04-24
R
R 4.3.0 released · 2023-04-21
0.8.1
record
2022-06-13 · diff ↗
R
R 4.2.0 released · 2022-04-22
0.7
record
2021-09-03 · diff ↗
R
R 4.1.0 released · 2021-05-18
0.6
record
2021-04-06
R
R 4.0.0 released · 2020-04-24

Package metadata

First published: 2021-04-06
Total releases: 5 / 5 yrs
License: GPL-2 OSI
Minimum R: ≥ 4.1.0
Download size: 16 KB

Cite

Cite this package

Run in R for the authors' preferred citation:

citation("GetFREData")

Format

Perlin, M., & Kirch, G. (2026). GetFREData: Reading FRE Corporate Data of Public Traded Companies from B3 (Version 1.1.0) [Computer software]. https://doi.org/10.32614/CRAN.package.GetFREData

This package has no citation file, so citation() returns this entry built from DESCRIPTION.

Cite the R Observatory

For a number measured here: a download total, a coverage figure, an archival date.

Format

APA

Balamuta, J. J. (2026). R Observatory: Metrics for GetFREData version 1.1.0 [Data set]. HJJB, LLC. Data release v2026-10-25. https://doi.org/10.5281/zenodo.21843040

From data release v2026-10-25, which the citation names so these numbers can be found later. More on citing and the projects behind them.

Report a problem with this page →