Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Capybara #645

Open
12 of 20 tasks
pachadotdev opened this issue Jun 1, 2024 · 92 comments
Open
12 of 20 tasks

Capybara #645

pachadotdev opened this issue Jun 1, 2024 · 92 comments
Assignees

Comments

@pachadotdev
Copy link

pachadotdev commented Jun 1, 2024

Submitting Author Name: Pacha
Submitting Author Github Handle: @pachadotdev
Repository: https://github.com/pachadotdev/capybara
Version submitted: 0.2.5 (initially)
Submission type: Stats
Badge grade: silver (?)
Editor: @rkillick
Reviewers: TBD

Archive: TBD
Version accepted: TBD
Language: en

  • Paste the full DESCRIPTION file inside a code block below:
Package: capybara
Type: Package
Title: Fast and Memory Efficient Fitting of Linear Models With High-Dimensional
    Fixed Effects
Version: 0.5.2
Authors@R: c(
    person(
        given = "Mauricio",
        family = "Vargas Sepulveda",
        role = c("aut", "cre"),
        email = "[email protected]",
        comment = c(ORCID = "0000-0003-1017-7574"))
    )
Imports:
    dplyr,
    Formula,
    generics,
    magrittr,
    MASS,
    rlang,
    stats
Suggests: 
    knitr,
    rmarkdown,
    testthat (>= 3.0.0),
    tidyr
Depends: R(>= 3.5.0)
Description: Fast and user-friendly estimation of generalized linear models with
    multiple fixed effects and cluster the standard errors. The method to obtain
    the estimated fixed-effects coefficients is based on Stammann (2018) 
    <https://arxiv.org/abs/1707.01815> and Gaure (2013)
    <https://dx.doi.org/10.1016/j.csda.2013.03.024>.
License: Apache License (>= 2)
BugReports: https://github.com/pachadotdev/capybara/issues
URL: https://pacha.dev/capybara/, https://github.com/pachadotdev/capybara
LazyData: true
RoxygenNote: 7.3.1
Encoding: UTF-8
NeedsCompilation: yes
LinkingTo: cpp11, cpp11armadillo
VignetteBuilder: knitr
Config/testthat/edition: 3
Remotes: 
    pachadotdev/cpp11armadillo,
    ropenscilabs/srr
Roxygen: list(markdown = TRUE, roclets = c("namespace", "rd", "srr::srr_stats_roclet"))

Scope

  • Please indicate which of our statistical package categories this package falls under. (Please check one or more appropriate boxes below):

    Statistical Packages

    • Bayesian and Monte Carlo Routines
    • Dimensionality Reduction, Clustering, and Unsupervised Learning
    • Machine Learning
    • Regression and Supervised Learning
    • Exploratory Data Analysis (EDA) and Summary Statistics
    • Spatial Analyses
    • Time Series Analyses
    • Probability Distributions

Pre-submission Inquiry

  • A pre-submission inquiry has been approved in issue#629

General Information

  • Who is the target audience and what are scientific applications of this package?

People (mostly) in the social sciences that need multiple controls in their models. This is especially useful in Economics and International Relations.

Badging

  • Have a demonstrated generality of usage beyond one single envisioned use case.
  • Compliance with a good number of standards beyond those identified as minimally necessary.

Technical checks

Confirm each of the following by checking the box.

This package:

Publication options

  • Do you intend for this package to go on CRAN?
  • Do you intend for this package to go on Bioconductor?

Code of conduct

@ropensci-review-bot
Copy link
Collaborator

Thanks for submitting to rOpenSci, our editors and @ropensci-review-bot will reply soon. Type @ropensci-review-bot help for help.

@ropensci-review-bot
Copy link
Collaborator

🚀

Editor check started

👋

@mpadge
Copy link
Member

mpadge commented Jun 3, 2024

@pachadotdev Checks failed because of the missing comma in your DESCRIPTION file which I see you've fixed in your latest commit. Ask the bot to check package again and it should work.

@pachadotdev
Copy link
Author

@ropensci-review-bot check package

@ropensci-review-bot
Copy link
Collaborator

Thanks, about to send the query.

@ropensci-review-bot
Copy link
Collaborator

🚀

Editor check started

👋

@ropensci-review-bot
Copy link
Collaborator

Checks for capybara (v0.5.1)

git hash: 55b6c2d8

  • ✔️ Package name is available
  • ✖️ does not have a 'codemeta.json' file.
  • ✖️ does not have a 'contributing' file.
  • ✖️ The following functions have no documented return values: [fenegbin, fepoisson]
  • ✔️ uses 'roxygen2'.
  • ✔️ 'DESCRIPTION' has a URL field.
  • ✔️ 'DESCRIPTION' has a BugReports field.
  • ✔️ Package has at least one HTML vignette
  • ✖️ These functions do not have examples: [feglm_control, summary.apes, summary.feglm, summary.felm, vcov.apes, vcov.feglm, vcov.felm].
  • ✔️ Package has continuous integration checks.
  • ✖️ Package coverage is 37.5% (should be at least 75%).
  • ✖️ This package still has TODO standards and can not be submitted
  • ✖️ Statistical standards should be documented in most package files, yet are mostly only documented in one file.
  • ✔️ R CMD check found no errors.
  • ✔️ R CMD check found no warnings.
  • 👀 Function names are duplicated in other packages

Important: All failing checks above must be addressed prior to proceeding

(Checks marked with 👀 may be optionally addressed.)

Package License: Apache License (>= 2)


1. rOpenSci Statistical Standards (srr package)

This package is in the following category:

  • Regression and Supervised Learning

✖️ This package still has TODO standards and can not be submitted
All applicable standards [v0.2.0] have been documented in this package (68 complied with; 1 N/A standards)
Statistical standards should be documented in most package files, yet are mostly only documented in one file.

Click to see the report of author-reported standards compliance of the package with links to associated lines of code, which can be re-generated locally by running the srr_report() function from within a local clone of the repository.


2. Package Dependencies

Details of Package Dependency Usage (click to open)

The table below tallies all function calls to all packages ('ncalls'), both internal (r-base + recommended, along with the package itself), and external (imported and suggested packages). 'NA' values indicate packages to which no identified calls to R functions could be found. Note that these results are generated by an automated code-tagging system which may not be entirely accurate.

type package ncalls
internal base 210
internal capybara 111
internal utils 47
internal grDevices 13
internal graphics 2
imports stats 115
imports rlang 22
imports magrittr 6
imports dplyr 4
imports MASS 4
imports Formula 1
suggests fixest NA
suggests knitr NA
suggests rmarkdown NA
suggests testthat NA
suggests tidyr NA
linking_to cpp11 NA
linking_to cpp11armadillo NA

Click below for tallies of functions used in each package. Locations of each call within this package may be generated locally by running 's <- pkgstats::pkgstats(<path/to/repo>)', and examining the 'external_calls' table.

base

length (13), for (11), list (11), seq.int (10), abs (9), beta (9), attr (8), drop (8), max (8), c (7), mapply (7), names (7), sum (7), nrow (6), ncol (5), matrix (4), trace (4), as.logical (3), cbind (3), class (3), diag (3), getOption (3), lapply (3), rep (3), sqrt (3), structure (3), try (3), with (3), all (2), apply (2), as.matrix (2), integer (2), is.finite (2), letters (2), levels (2), mean (2), nchar (2), numeric (2), paste0 (2), replace (2), sample (2), unlist (2), vapply (2), as.data.frame (1), as.list (1), as.vector (1), colnames (1), colSums (1), data.frame (1), inherits (1), min (1), order (1), rownames (1), summary (1), suppressWarnings (1), unname (1)

stats

family (36), formula (25), nobs (14), model.matrix (10), deviance (4), terms (4), Gamma (3), offset (3), pnorm (3), vcov (3), weights (3), coefficients (2), D (2), C (1), poisson (1), predict (1)

capybara

get_index_list_ (8), crossprod_ (5), feglm_fit_ (3), group_sums_ (3), nobs_ (3), partial_mu_eta_ (3), solve_beta_ (3), solve_y_ (3), center_variables_ (2), check_factor_ (2), feglm (2), gamma_ (2), get_alpha_ (2), getScoreMatrix (2), group_sums_cov_ (2), init_theta_ (2), inv_ (2), solve_bias_ (2), solve_eta_ (2), solve_eta2_ (2), sqrt_ (2), temp_var_ (2), apes (1), augment.feglm (1), bias_corr (1), check_control_ (1), check_data_ (1), check_family_ (1), check_formula_ (1), check_linear_dependence_ (1), check_response_ (1), check_weights_ (1), coef.apes (1), coef.feglm (1), coef.felm (1), coef.summary.apes (1), coef.summary.feglm (1), coef.summary.felm (1), drop_by_link_type_ (1), feglm_control (1), feglm_offset_ (1), felm (1), felm_fit_ (1), fenegbin (1), fepoisson (1), fitted.feglm (1), fitted.felm (1), fixed_effects (1), glance.feglm (1), glance.felm (1), group_sums_spectral_ (1), group_sums_var_ (1), model_frame_ (1), model_response_ (1), pairwise_cor_ (1), predict.feglm (1), predict.felm (1), print.apes (1), print.feglm (1), print.felm (1), print.summary.apes (1), print.summary.feglm (1), print.summary.felm (1), rank_ (1), sandwich_ (1), start_guesses_ (1), summary_estimates_ (1), summary_family_ (1), summary_fisher_ (1), summary_formula_ (1), summary.apes (1), summary.feglm (1), summary.felm (1), update_nu_ (1)

utils

data (46), combn (1)

rlang

sym (22)

grDevices

cm (13)

magrittr

%>% (6)

dplyr

all_of (2), select (2)

MASS

negative.binomial (2), theta.ml (2)

graphics

pie (2)

Formula

Formula (1)


3. Statistical Properties

This package features some noteworthy statistical properties which may need to be clarified by a handling editor prior to progressing.

Details of statistical properties (click to open)

The package has:

  • code in C++ (26% in 6 files) and R (74% in 23 files)
  • 1 authors
  • 1 vignette
  • 1 internal data file
  • 7 imported packages
  • 14 exported functions (median 22 lines of code)
  • 163 non-exported functions in R (median 6 lines of code)
  • 45 R functions (median 5 lines of code)

Statistical properties of package structure as distributional percentiles in relation to all current CRAN packages
The following terminology is used:

  • loc = "Lines of Code"
  • fn = "function"
  • exp/not_exp = exported / not exported

All parameters are explained as tooltips in the locally-rendered HTML version of this report generated by the checks_to_markdown() function

The final measure (fn_call_network_size) is the total number of calls between functions (in R), or more abstract relationships between code objects in other languages. Values are flagged as "noteworthy" when they lie in the upper or lower 5th percentile.

measure value percentile noteworthy
files_R 23 84.5
files_src 6 90.2
files_vignettes 2 85.7
files_tests 6 84.4
loc_R 1554 78.9
loc_src 549 48.8
loc_vignettes 81 19.3
loc_tests 228 58.3
num_vignettes 1 64.8
data_size_total 285103 89.1
data_size_median 285103 95.3 TRUE
n_fns_r 177 88.0
n_fns_r_exported 14 56.3
n_fns_r_not_exported 163 91.1
n_fns_src 45 64.7
n_fns_per_file_r 4 63.6
n_fns_per_file_src 7 66.4
num_params_per_fn 3 33.6
loc_per_fn_r 7 16.0
loc_per_fn_r_exp 22 52.1
loc_per_fn_r_not_exp 6 13.8
loc_per_fn_src 5 5.0 TRUE
rel_whitespace_R 20 80.6
rel_whitespace_src 24 55.8
rel_whitespace_vignettes 23 12.6
rel_whitespace_tests 22 56.4
doclines_per_fn_exp 34 41.6
doclines_per_fn_not_exp 0 0.0 TRUE
fn_call_network_size 145 84.8

3a. Network visualisation

Click to see the interactive network visualisation of calls between objects in package


4. goodpractice and other checks

Details of goodpractice checks (click to open)

3a. Continuous Integration Badges

R-CMD-check.yaml

GitHub Workflow Results

id name conclusion sha run_number date
9340075153 format_check failure 55b6c2 35 2024-06-02
9340075080 pages build and deployment success 55b6c2 57 2024-06-02
9340075152 R-CMD-check success 55b6c2 55 2024-06-02
9340075157 test-coverage success 55b6c2 34 2024-06-02

3b. goodpractice results

R CMD check with rcmdcheck

R CMD check generated the following note:

  1. checking installed package size ... NOTE
    installed size is 9.0Mb
    sub-directories of 1Mb or more:
    libs 8.2Mb

R CMD check generated the following check_fail:

  1. rcmdcheck_reasonable_installed_size

Test coverage with covr

Package coverage: 37.48

The following files are not completely covered by tests:

file coverage
R/apes.R 24.26%
R/bias_corr.R 0%
R/felm.R 0%
R/fenegbin.R 0%
R/fixed_effects.R 0%
R/generics_augment.R 0%
R/generics_coef.R 0%
R/generics_fitted.R 0%
R/generics_glance.R 0%
R/generics_print.R 0%
R/generics_summary.R 39.66%
R/generics_tidy.R 0%
R/generics_vcov.R 52.63%
R/helpers.R 63.19%
R/internals.R 54.82%
src/02_get_alpha.cpp 0%
src/03_group_sums.cpp 0%

Cyclocomplexity with cyclocomp

The following functions have cyclocomplexity >= 15:

function cyclocomplexity
apes 38
feglm_fit_ 26
feglm_offset_ 21
bias_corr 19
vcov.feglm 18
fenegbin 15

Static code analyses with lintr

lintr found the following 124 potential issues:

message number of times
Avoid 1:ncol(...) expressions, use seq_len. 2
Avoid library() and require() calls in packages 1
Lines should not be more than 80 characters. This line is 103 characters. 1
Lines should not be more than 80 characters. This line is 104 characters. 1
Lines should not be more than 80 characters. This line is 105 characters. 1
Lines should not be more than 80 characters. This line is 106 characters. 2
Lines should not be more than 80 characters. This line is 108 characters. 1
Lines should not be more than 80 characters. This line is 110 characters. 2
Lines should not be more than 80 characters. This line is 113 characters. 1
Lines should not be more than 80 characters. This line is 114 characters. 2
Lines should not be more than 80 characters. This line is 115 characters. 1
Lines should not be more than 80 characters. This line is 116 characters. 1
Lines should not be more than 80 characters. This line is 117 characters. 2
Lines should not be more than 80 characters. This line is 121 characters. 1
Lines should not be more than 80 characters. This line is 122 characters. 2
Lines should not be more than 80 characters. This line is 126 characters. 1
Lines should not be more than 80 characters. This line is 128 characters. 1
Lines should not be more than 80 characters. This line is 129 characters. 1
Lines should not be more than 80 characters. This line is 131 characters. 2
Lines should not be more than 80 characters. This line is 132 characters. 1
Lines should not be more than 80 characters. This line is 133 characters. 1
Lines should not be more than 80 characters. This line is 134 characters. 1
Lines should not be more than 80 characters. This line is 136 characters. 1
Lines should not be more than 80 characters. This line is 141 characters. 1
Lines should not be more than 80 characters. This line is 142 characters. 1
Lines should not be more than 80 characters. This line is 144 characters. 1
Lines should not be more than 80 characters. This line is 145 characters. 1
Lines should not be more than 80 characters. This line is 147 characters. 1
Lines should not be more than 80 characters. This line is 151 characters. 1
Lines should not be more than 80 characters. This line is 154 characters. 1
Lines should not be more than 80 characters. This line is 155 characters. 1
Lines should not be more than 80 characters. This line is 156 characters. 1
Lines should not be more than 80 characters. This line is 161 characters. 2
Lines should not be more than 80 characters. This line is 163 characters. 1
Lines should not be more than 80 characters. This line is 165 characters. 2
Lines should not be more than 80 characters. This line is 166 characters. 1
Lines should not be more than 80 characters. This line is 169 characters. 1
Lines should not be more than 80 characters. This line is 170 characters. 1
Lines should not be more than 80 characters. This line is 174 characters. 3
Lines should not be more than 80 characters. This line is 176 characters. 1
Lines should not be more than 80 characters. This line is 178 characters. 1
Lines should not be more than 80 characters. This line is 184 characters. 4
Lines should not be more than 80 characters. This line is 185 characters. 1
Lines should not be more than 80 characters. This line is 193 characters. 1
Lines should not be more than 80 characters. This line is 195 characters. 2
Lines should not be more than 80 characters. This line is 199 characters. 1
Lines should not be more than 80 characters. This line is 214 characters. 1
Lines should not be more than 80 characters. This line is 217 characters. 1
Lines should not be more than 80 characters. This line is 219 characters. 1
Lines should not be more than 80 characters. This line is 220 characters. 1
Lines should not be more than 80 characters. This line is 223 characters. 1
Lines should not be more than 80 characters. This line is 225 characters. 1
Lines should not be more than 80 characters. This line is 229 characters. 1
Lines should not be more than 80 characters. This line is 230 characters. 1
Lines should not be more than 80 characters. This line is 232 characters. 1
Lines should not be more than 80 characters. This line is 244 characters. 1
Lines should not be more than 80 characters. This line is 247 characters. 1
Lines should not be more than 80 characters. This line is 250 characters. 1
Lines should not be more than 80 characters. This line is 257 characters. 1
Lines should not be more than 80 characters. This line is 261 characters. 1
Lines should not be more than 80 characters. This line is 269 characters. 2
Lines should not be more than 80 characters. This line is 277 characters. 2
Lines should not be more than 80 characters. This line is 279 characters. 1
Lines should not be more than 80 characters. This line is 282 characters. 1
Lines should not be more than 80 characters. This line is 287 characters. 1
Lines should not be more than 80 characters. This line is 288 characters. 1
Lines should not be more than 80 characters. This line is 291 characters. 1
Lines should not be more than 80 characters. This line is 293 characters. 1
Lines should not be more than 80 characters. This line is 305 characters. 1
Lines should not be more than 80 characters. This line is 318 characters. 1
Lines should not be more than 80 characters. This line is 320 characters. 2
Lines should not be more than 80 characters. This line is 333 characters. 1
Lines should not be more than 80 characters. This line is 334 characters. 1
Lines should not be more than 80 characters. This line is 339 characters. 1
Lines should not be more than 80 characters. This line is 341 characters. 1
Lines should not be more than 80 characters. This line is 360 characters. 1
Lines should not be more than 80 characters. This line is 363 characters. 1
Lines should not be more than 80 characters. This line is 385 characters. 1
Lines should not be more than 80 characters. This line is 389 characters. 1
Lines should not be more than 80 characters. This line is 396 characters. 1
Lines should not be more than 80 characters. This line is 441 characters. 1
Lines should not be more than 80 characters. This line is 81 characters. 2
Lines should not be more than 80 characters. This line is 82 characters. 3
Lines should not be more than 80 characters. This line is 83 characters. 1
Lines should not be more than 80 characters. This line is 84 characters. 1
Lines should not be more than 80 characters. This line is 85 characters. 1
Lines should not be more than 80 characters. This line is 86 characters. 2
Lines should not be more than 80 characters. This line is 87 characters. 1
Lines should not be more than 80 characters. This line is 88 characters. 1
Lines should not be more than 80 characters. This line is 90 characters. 1
Lines should not be more than 80 characters. This line is 91 characters. 1
Lines should not be more than 80 characters. This line is 92 characters. 5
Lines should not be more than 80 characters. This line is 94 characters. 2
Lines should not be more than 80 characters. This line is 95 characters. 2
Lines should not be more than 80 characters. This line is 96 characters. 1
Lines should not be more than 80 characters. This line is 98 characters. 1


5. Other Checks

Details of other checks (click to open)

✖️ The following 4 function names are duplicated in other packages:

    • bias_corr from bife
    • feglm from alpaca
    • felm from lfe
    • fixed_effects from baggr, gratia, gravity


Package Versions

package version
pkgstats 0.1.5.2
pkgcheck 0.1.2.42
srr 0.1.3.2


Editor-in-Chief Instructions:

Processing may not proceed until the items marked with ✖️ have been resolved.

@jooolia
Copy link
Member

jooolia commented Jun 5, 2024

Dear @pachadotdev , Thank you for your submission.

You have checked "Regression and Supervised Learning" which would entail a "Statistical software review" (a different issue template to be opened, but that is ok). Would you be willing to go through the statistical software review as described here and implementing the standards:https://stats-devguide.ropensci.org/pkgdev.html

Thanks, Julia

@pachadotdev
Copy link
Author

Dear @pachadotdev , Thank you for your submission.

You have checked "Regression and Supervised Learning" which would entail a "Statistical software review" (a different issue template to be opened, but that is ok). Would you be willing to go through the statistical software review as described here and implementing the standards:https://stats-devguide.ropensci.org/pkgdev.html

Thanks, Julia

thanks a lot !

indeed, when I opened the issue that was the only available template on my end

I already implemented https://stats-devguide.ropensci.org/pkgdev.html#pkgdev-srr

@pachadotdev
Copy link
Author

@ropensci-review-bot check package

@ropensci-review-bot
Copy link
Collaborator

Thanks, about to send the query.

@ropensci-review-bot
Copy link
Collaborator

🚀

Editor check started

👋

@ropensci-review-bot
Copy link
Collaborator

Checks for capybara (v0.5.1)

git hash: f277de6d

  • ✔️ Package name is available
  • ✔️ has a 'codemeta.json' file.
  • ✔️ has a 'contributing' file.
  • ✔️ uses 'roxygen2'.
  • ✔️ 'DESCRIPTION' has a URL field.
  • ✔️ 'DESCRIPTION' has a BugReports field.
  • ✔️ Package has at least one HTML vignette
  • ✖️ These functions do not have examples: [feglm_control].
  • ✔️ Package has continuous integration checks.
  • ✖️ Package coverage is 74.9% (should be at least 75%).
  • ✖️ This package still has TODO standards and can not be submitted
  • ✖️ Statistical standards should be documented in most package files, yet are mostly only documented in one file.
  • ✔️ R CMD check found no errors.
  • ✔️ R CMD check found no warnings.
  • 👀 Function names are duplicated in other packages

Important: All failing checks above must be addressed prior to proceeding

(Checks marked with 👀 may be optionally addressed.)

Package License: Apache License (>= 2)


1. rOpenSci Statistical Standards (srr package)

This package is in the following category:

  • Regression and Supervised Learning

✖️ This package still has TODO standards and can not be submitted
All applicable standards [v0.2.0] have been documented in this package (68 complied with; 1 N/A standards)
Statistical standards should be documented in most package files, yet are mostly only documented in one file.

Click to see the report of author-reported standards compliance of the package with links to associated lines of code, which can be re-generated locally by running the srr_report() function from within a local clone of the repository.


2. Package Dependencies

Details of Package Dependency Usage (click to open)

The table below tallies all function calls to all packages ('ncalls'), both internal (r-base + recommended, along with the package itself), and external (imported and suggested packages). 'NA' values indicate packages to which no identified calls to R functions could be found. Note that these results are generated by an automated code-tagging system which may not be entirely accurate.

type package ncalls
internal base 209
internal capybara 109
internal utils 47
internal grDevices 13
internal graphics 2
imports stats 114
imports rlang 22
imports magrittr 6
imports dplyr 4
imports MASS 4
imports Formula 1
suggests fixest NA
suggests knitr NA
suggests rmarkdown NA
suggests testthat NA
suggests tidyr NA
linking_to cpp11 NA
linking_to cpp11armadillo NA

Click below for tallies of functions used in each package. Locations of each call within this package may be generated locally by running 's <- pkgstats::pkgstats(<path/to/repo>)', and examining the 'external_calls' table.

base

length (13), for (11), list (11), seq.int (10), abs (9), beta (9), attr (8), drop (8), max (8), c (7), mapply (7), names (7), sum (7), nrow (6), ncol (5), matrix (4), trace (4), as.logical (3), cbind (3), class (3), diag (3), getOption (3), lapply (3), rep (3), sqrt (3), structure (3), try (3), with (3), all (2), apply (2), as.matrix (2), integer (2), is.finite (2), letters (2), levels (2), mean (2), nchar (2), numeric (2), paste0 (2), replace (2), sample (2), vapply (2), as.data.frame (1), as.list (1), as.vector (1), colnames (1), colSums (1), data.frame (1), inherits (1), min (1), order (1), rownames (1), summary (1), suppressWarnings (1), unlist (1), unname (1)

stats

family (36), formula (25), nobs (14), model.matrix (10), deviance (4), terms (4), Gamma (3), offset (3), pnorm (3), vcov (3), weights (3), coefficients (2), D (2), C (1), poisson (1)

capybara

get_index_list_ (8), crossprod_ (5), feglm_fit_ (3), group_sums_ (3), nobs_ (3), partial_mu_eta_ (3), solve_beta_ (3), solve_y_ (3), center_variables_ (2), check_factor_ (2), feglm (2), gamma_ (2), get_alpha_ (2), getScoreMatrix (2), group_sums_cov_ (2), init_theta_ (2), inv_ (2), solve_bias_ (2), solve_eta_ (2), solve_eta2_ (2), sqrt_ (2), temp_var_ (2), apes (1), augment.feglm (1), bias_corr (1), check_control_ (1), check_data_ (1), check_family_ (1), check_formula_ (1), check_linear_dependence_ (1), check_response_ (1), check_weights_ (1), coef.apes (1), coef.feglm (1), coef.felm (1), coef.summary.apes (1), coef.summary.feglm (1), coef.summary.felm (1), drop_by_link_type_ (1), feglm_control (1), feglm_offset_ (1), felm (1), felm_fit_ (1), fenegbin (1), fepoisson (1), fitted.feglm (1), fitted.felm (1), fixed_effects (1), glance.feglm (1), glance.felm (1), group_sums_spectral_ (1), group_sums_var_ (1), model_frame_ (1), model_response_ (1), predict.feglm (1), predict.felm (1), print.apes (1), print.feglm (1), print.felm (1), print.summary.apes (1), print.summary.feglm (1), print.summary.felm (1), rank_ (1), sandwich_ (1), start_guesses_ (1), summary_estimates_ (1), summary_family_ (1), summary_fisher_ (1), summary.apes (1), summary.feglm (1), summary.felm (1), update_nu_ (1)

utils

data (46), combn (1)

rlang

sym (22)

grDevices

cm (13)

magrittr

%>% (6)

dplyr

all_of (2), select (2)

MASS

negative.binomial (2), theta.ml (2)

graphics

pie (2)

Formula

Formula (1)


3. Statistical Properties

This package features some noteworthy statistical properties which may need to be clarified by a handling editor prior to progressing.

Details of statistical properties (click to open)

The package has:

  • code in C++ (24% in 5 files) and R (76% in 23 files)
  • 1 authors
  • 1 vignette
  • 1 internal data file
  • 7 imported packages
  • 10 exported functions (median 39 lines of code)
  • 163 non-exported functions in R (median 7 lines of code)
  • 39 R functions (median 5 lines of code)

Statistical properties of package structure as distributional percentiles in relation to all current CRAN packages
The following terminology is used:

  • loc = "Lines of Code"
  • fn = "function"
  • exp/not_exp = exported / not exported

All parameters are explained as tooltips in the locally-rendered HTML version of this report generated by the checks_to_markdown() function

The final measure (fn_call_network_size) is the total number of calls between functions (in R), or more abstract relationships between code objects in other languages. Values are flagged as "noteworthy" when they lie in the upper or lower 5th percentile.

measure value percentile noteworthy
files_R 23 84.5
files_src 5 88.8
files_vignettes 2 85.7
files_tests 9 89.6
loc_R 1537 78.7
loc_src 496 46.6
loc_vignettes 81 19.3
loc_tests 289 63.3
num_vignettes 1 64.8
data_size_total 285103 89.1
data_size_median 285103 95.3 TRUE
n_fns_r 173 87.5
n_fns_r_exported 10 45.3
n_fns_r_not_exported 163 91.1
n_fns_src 39 61.4
n_fns_per_file_r 4 62.9
n_fns_per_file_src 8 68.5
num_params_per_fn 4 54.6
loc_per_fn_r 7 16.0
loc_per_fn_r_exp 40 72.6
loc_per_fn_r_not_exp 7 18.0
loc_per_fn_src 5 5.0 TRUE
rel_whitespace_R 20 80.5
rel_whitespace_src 24 53.5
rel_whitespace_vignettes 23 12.6
rel_whitespace_tests 24 63.8
doclines_per_fn_exp 44 55.5
doclines_per_fn_not_exp 0 0.0 TRUE
fn_call_network_size 137 84.0

3a. Network visualisation

Click to see the interactive network visualisation of calls between objects in package


4. goodpractice and other checks

Details of goodpractice checks (click to open)

3a. Continuous Integration Badges

R-CMD-check.yaml

GitHub Workflow Results

id name conclusion sha run_number date
9557026802 format_check failure f277de 37 2024-06-18
9557026743 pages build and deployment success f277de 59 2024-06-18
9557026803 R-CMD-check failure f277de 57 2024-06-18
9557026804 test-coverage success f277de 36 2024-06-18

3b. goodpractice results

R CMD check with rcmdcheck

R CMD check generated the following note:

  1. checking installed package size ... NOTE
    installed size is 8.1Mb
    sub-directories of 1Mb or more:
    libs 7.4Mb

R CMD check generated the following check_fail:

  1. rcmdcheck_reasonable_installed_size

Test coverage with covr

Package coverage: 74.89

Cyclocomplexity with cyclocomp

The following functions have cyclocomplexity >= 15:

function cyclocomplexity
apes 38
feglm_fit_ 26
feglm_offset_ 21
bias_corr 19
vcov.feglm 18
fenegbin 15

Static code analyses with lintr

lintr found the following 125 potential issues:

message number of times
Avoid 1:ncol(...) expressions, use seq_len. 2
Avoid library() and require() calls in packages 1
Lines should not be more than 80 characters. This line is 103 characters. 2
Lines should not be more than 80 characters. This line is 104 characters. 1
Lines should not be more than 80 characters. This line is 105 characters. 1
Lines should not be more than 80 characters. This line is 106 characters. 2
Lines should not be more than 80 characters. This line is 108 characters. 1
Lines should not be more than 80 characters. This line is 110 characters. 2
Lines should not be more than 80 characters. This line is 113 characters. 1
Lines should not be more than 80 characters. This line is 114 characters. 2
Lines should not be more than 80 characters. This line is 115 characters. 1
Lines should not be more than 80 characters. This line is 116 characters. 1
Lines should not be more than 80 characters. This line is 117 characters. 2
Lines should not be more than 80 characters. This line is 121 characters. 1
Lines should not be more than 80 characters. This line is 122 characters. 2
Lines should not be more than 80 characters. This line is 126 characters. 1
Lines should not be more than 80 characters. This line is 128 characters. 1
Lines should not be more than 80 characters. This line is 129 characters. 1
Lines should not be more than 80 characters. This line is 131 characters. 2
Lines should not be more than 80 characters. This line is 132 characters. 1
Lines should not be more than 80 characters. This line is 133 characters. 1
Lines should not be more than 80 characters. This line is 134 characters. 1
Lines should not be more than 80 characters. This line is 136 characters. 1
Lines should not be more than 80 characters. This line is 141 characters. 1
Lines should not be more than 80 characters. This line is 142 characters. 1
Lines should not be more than 80 characters. This line is 144 characters. 1
Lines should not be more than 80 characters. This line is 145 characters. 1
Lines should not be more than 80 characters. This line is 147 characters. 1
Lines should not be more than 80 characters. This line is 151 characters. 1
Lines should not be more than 80 characters. This line is 154 characters. 1
Lines should not be more than 80 characters. This line is 155 characters. 1
Lines should not be more than 80 characters. This line is 156 characters. 1
Lines should not be more than 80 characters. This line is 161 characters. 2
Lines should not be more than 80 characters. This line is 163 characters. 1
Lines should not be more than 80 characters. This line is 165 characters. 2
Lines should not be more than 80 characters. This line is 166 characters. 1
Lines should not be more than 80 characters. This line is 169 characters. 1
Lines should not be more than 80 characters. This line is 170 characters. 1
Lines should not be more than 80 characters. This line is 174 characters. 3
Lines should not be more than 80 characters. This line is 176 characters. 1
Lines should not be more than 80 characters. This line is 178 characters. 1
Lines should not be more than 80 characters. This line is 184 characters. 4
Lines should not be more than 80 characters. This line is 185 characters. 1
Lines should not be more than 80 characters. This line is 193 characters. 1
Lines should not be more than 80 characters. This line is 195 characters. 2
Lines should not be more than 80 characters. This line is 199 characters. 1
Lines should not be more than 80 characters. This line is 214 characters. 1
Lines should not be more than 80 characters. This line is 217 characters. 1
Lines should not be more than 80 characters. This line is 219 characters. 1
Lines should not be more than 80 characters. This line is 220 characters. 1
Lines should not be more than 80 characters. This line is 223 characters. 1
Lines should not be more than 80 characters. This line is 225 characters. 1
Lines should not be more than 80 characters. This line is 229 characters. 1
Lines should not be more than 80 characters. This line is 230 characters. 1
Lines should not be more than 80 characters. This line is 232 characters. 1
Lines should not be more than 80 characters. This line is 244 characters. 1
Lines should not be more than 80 characters. This line is 247 characters. 1
Lines should not be more than 80 characters. This line is 250 characters. 1
Lines should not be more than 80 characters. This line is 257 characters. 1
Lines should not be more than 80 characters. This line is 261 characters. 1
Lines should not be more than 80 characters. This line is 269 characters. 2
Lines should not be more than 80 characters. This line is 277 characters. 2
Lines should not be more than 80 characters. This line is 279 characters. 1
Lines should not be more than 80 characters. This line is 282 characters. 1
Lines should not be more than 80 characters. This line is 287 characters. 1
Lines should not be more than 80 characters. This line is 288 characters. 1
Lines should not be more than 80 characters. This line is 291 characters. 1
Lines should not be more than 80 characters. This line is 293 characters. 1
Lines should not be more than 80 characters. This line is 305 characters. 1
Lines should not be more than 80 characters. This line is 318 characters. 1
Lines should not be more than 80 characters. This line is 320 characters. 2
Lines should not be more than 80 characters. This line is 333 characters. 1
Lines should not be more than 80 characters. This line is 334 characters. 1
Lines should not be more than 80 characters. This line is 339 characters. 1
Lines should not be more than 80 characters. This line is 341 characters. 1
Lines should not be more than 80 characters. This line is 360 characters. 1
Lines should not be more than 80 characters. This line is 363 characters. 1
Lines should not be more than 80 characters. This line is 385 characters. 1
Lines should not be more than 80 characters. This line is 389 characters. 1
Lines should not be more than 80 characters. This line is 396 characters. 1
Lines should not be more than 80 characters. This line is 441 characters. 1
Lines should not be more than 80 characters. This line is 81 characters. 2
Lines should not be more than 80 characters. This line is 82 characters. 3
Lines should not be more than 80 characters. This line is 83 characters. 1
Lines should not be more than 80 characters. This line is 84 characters. 1
Lines should not be more than 80 characters. This line is 85 characters. 1
Lines should not be more than 80 characters. This line is 86 characters. 2
Lines should not be more than 80 characters. This line is 87 characters. 1
Lines should not be more than 80 characters. This line is 88 characters. 1
Lines should not be more than 80 characters. This line is 90 characters. 1
Lines should not be more than 80 characters. This line is 91 characters. 1
Lines should not be more than 80 characters. This line is 92 characters. 5
Lines should not be more than 80 characters. This line is 94 characters. 2
Lines should not be more than 80 characters. This line is 95 characters. 2
Lines should not be more than 80 characters. This line is 96 characters. 1
Lines should not be more than 80 characters. This line is 98 characters. 1


5. Other Checks

Details of other checks (click to open)

✖️ The following 4 function names are duplicated in other packages:

    • bias_corr from bife
    • feglm from alpaca
    • felm from lfe
    • fixed_effects from baggr, gratia, gravity


Package Versions

package version
pkgstats 0.1.5.2
pkgcheck 0.1.2.42
srr 0.1.3.2


Editor-in-Chief Instructions:

Processing may not proceed until the items marked with ✖️ have been resolved.

@pachadotdev
Copy link
Author

@jooolia Hi, I cannot find the statistical review template.

@jooolia
Copy link
Member

jooolia commented Jun 29, 2024

Hi @pachadotdev , sorry for the delayed response. You have the option of several different types of templates when you open an issue the statistical one is the last choice (the template is viewable here: https://github.com/ropensci/software-review/blob/main/.github/ISSUE_TEMPLATE/F-submit-statistical-software-for-review.md). Does this help? Thanks, Julia

@pachadotdev
Copy link
Author

hi @jooolia
I think the software is ready for review as is

@jooolia
Copy link
Member

jooolia commented Jul 26, 2024

Dear @pachadotdev , thanks for your patience. We are discussing with the statistical editors and will get back to you shortly.
Thanks, Julia

@pachadotdev
Copy link
Author

Dear @pachadotdev , thanks for your patience. We are discussing with the statistical editors and will get back to you shortly. Thanks, Julia

thanks! I uploaded some changes yesterday

@jooolia
Copy link
Member

jooolia commented Jul 29, 2024

Dear @pachadotdev, thanks for updating to address the statistical aspects of the package. Currently there are some srrstatsTODO tags in your srr-stats-standards.R file and we note that "software to be submitted for review must contain no @srrstatsTODO tags" (https://stats-devguide.ropensci.org/pkgdev.html#pkgdev-srr).

Could you also edit your first comment in this issue so that it contains the comment here #645 (comment) (e.g. replace the content with the statistical issue content? )

Thanks, Julia

@pachadotdev
Copy link
Author

Dear @pachadotdev, thanks for updating to address the statistical aspects of the package. Currently there are some srrstatsTODO tags in your srr-stats-standards.R file and we note that "software to be submitted for review must contain no @srrstatsTODO tags" (https://stats-devguide.ropensci.org/pkgdev.html#pkgdev-srr).

Could you also edit your first comment in this issue so that it contains the comment here #645 (comment) (e.g. replace the content with the statistical issue content? )

Thanks, Julia

thanks!

I updated the comment. I will need 3-4 weeks to finish all the srrstatsTODO

@jooolia
Copy link
Member

jooolia commented Jul 30, 2024

Ok thanks @pachadotdev for the update. Another editor will take over from me in few days to continue helping with the process. Cheers, Julia

@adamhsparks
Copy link
Member

Hi, @pachadotdev, I'm taking over where @jooolia is leaving off as EIC. Please let me know what assistance you may need from me.

@jooolia jooolia removed their assignment Aug 3, 2024
@adamhsparks adamhsparks self-assigned this Aug 4, 2024
@pachadotdev
Copy link
Author

hi @adamhsparks
I think the pkg is ready for review

@adamhsparks
Copy link
Member

@ropensci-review-bot check package

@ropensci-review-bot
Copy link
Collaborator

Thanks, about to send the query.

@ropensci-review-bot
Copy link
Collaborator

🚀

Error: Issue template has no 'repourl'

👋

@ropensci-review-bot
Copy link
Collaborator

The following standards are missing:

General standards:

G1.3, G1.5, G1.6, G2.0a, G2.4a, G2.4b, G2.4c, G2.4d, G2.4e, G2.6, G2.7, G2.8, G2.9, G2.10, G2.11, G2.12, G2.14, G2.14c, G2.15, G2.16, G5.0, G5.2b, G5.3, G5.4, G5.4b, G5.4c, G5.5, G5.6, G5.6a, G5.7, G5.8, G5.8a, G5.8b, G5.8c, G5.8d, G5.9, G5.9a, G5.9b

Regression standards:

RE1.0, RE1.1, RE1.2, RE1.3, RE1.3a, RE1.4, RE2.0, RE2.4, RE2.4a, RE2.4b, RE3.0, RE4.0, RE4.1, RE4.2, RE4.4, RE4.5, RE4.6, RE4.7, RE4.8, RE4.9, RE4.10, RE4.11, RE4.12, RE4.13, RE4.14, RE4.15, RE4.16, RE4.17, RE4.18, RE6.2, RE6.3, RE7.0, RE7.0a, RE7.1a, RE7.4

All standards must be documented prior to submission

@pachadotdev
Copy link
Author

@ropensci-review-bot check srr

1 similar comment
@pachadotdev
Copy link
Author

@ropensci-review-bot check srr

@ropensci-review-bot
Copy link
Collaborator

The following standards are missing:

General standards:

G2.6, G2.7, G2.8, G2.9, G2.10, G2.11, G2.12, G2.14, G2.14c, G2.15, G2.16

Regression standards:

RE2.4a, RE2.4b, RE3.0, RE4.0, RE4.2, RE4.4, RE4.5, RE4.8, RE4.9, RE4.10, RE4.11, RE4.12, RE4.13, RE4.15, RE4.16, RE4.17, RE4.18, RE6.2, RE6.3, RE7.0, RE7.1a

All standards must be documented prior to submission

@pachadotdev
Copy link
Author

@ropensci-review-bot check srr

@ropensci-review-bot
Copy link
Collaborator

The following standards are missing:

Regression standards:

RE7.1a

All standards must be documented prior to submission

@pachadotdev
Copy link
Author

@ropensci-review-bot check srr

@ropensci-review-bot
Copy link
Collaborator

'srr' standards compliance:

  • Complied with: 121 / 130 = 93.1% (general: 69 / 75; regression: 52 / 55)
  • Not complied with: 9 / 130 = 6.9% (general: 6 / 75; regression: 3 / 55)

✔️ This package complies with > 50% of all standards.

@pachadotdev
Copy link
Author

pachadotdev commented Nov 23, 2024

hi @adamhsparks
I took a different approach now, I and proceeded to explain the code in the srr headers. Some explanations are too obvious but I did exactly what was requested. My approach was "not everybody has read Hansen's Econometrics, so it is not obvious how to pre-process the data"

@adamhsparks
Copy link
Member

adamhsparks commented Dec 1, 2024

Hi, @pachadotdev, my time as EIC ended at the beginning of last month. Thank you for all your work to get {Capybara} to this point.

Pinging @emilyriederer as the current acting EIC to action your submission.

@pachadotdev
Copy link
Author

hi @emilyriederer :)

@emilyriederer
Copy link

Hi @pachadotdev ! Our general guidance is that authors should have one live review at a time to manage overall capacity. Do you want to move forward here and we'll put {redatam} on hold for now?

@pachadotdev
Copy link
Author

Hi @pachadotdev ! Our general guidance is that authors should have one live review at a time to manage overall capacity. Do you want to move forward here and we'll put {redatam} on hold for now?

yes, Lital has not responded yet, so redatam should wait

@emilyriederer emilyriederer mentioned this issue Dec 10, 2024
21 tasks
@emilyriederer
Copy link

@ropensci-review-bot check srr

@ropensci-review-bot
Copy link
Collaborator

'srr' standards compliance:

  • Complied with: 121 / 130 = 93.1% (general: 69 / 75; regression: 52 / 55)
  • Not complied with: 9 / 130 = 6.9% (general: 6 / 75; regression: 3 / 55)

✔️ This package complies with > 50% of all standards.

@adamhsparks adamhsparks removed their assignment Dec 11, 2024
@emilyriederer
Copy link

@ropensci-review-bot check package

@ropensci-review-bot
Copy link
Collaborator

Thanks, about to send the query.

@ropensci-review-bot
Copy link
Collaborator

🚀

Editor check started

👋

@ropensci-review-bot
Copy link
Collaborator

Checks for capybara (v0.7.0)

git hash: 5535f883

  • ✔️ Package name is available
  • ✔️ has a 'codemeta.json' file.
  • ✔️ has a 'contributing' file.
  • ✔️ uses 'roxygen2'.
  • ✔️ 'DESCRIPTION' has a URL field.
  • ✔️ 'DESCRIPTION' has a BugReports field.
  • ✔️ Package has at least one HTML vignette
  • ✔️ All functions have examples.
  • ✔️ Package has continuous integration checks.
  • ✔️ Package coverage is 80.4%.
  • ✔️ R CMD check found no errors.
  • ✔️ R CMD check found no warnings.
  • 👀 Function names are duplicated in other packages

(Checks marked with 👀 may be optionally addressed.)

Package License: Apache License (>= 2)


1. rOpenSci Statistical Standards (srr package)

This package is in the following category:

  • Regression and Supervised Learning

✔️ Your code includes the following standards which are not actual standards: [G2.1b]
Your code includes the following standards which are not actual standards: [RE5.1]
Your code includes the following standards which are not actual standards: [RE5.2]
Your code includes the following standards which are not actual standards: [RE5.3]
Your code includes the following standards which are not actual standards: [G3.1b]
Your code includes the following standards which are not actual standards: [G3.3]
Your code includes the following standards which are not actual standards: [G3.1c]
Your code includes the following standards which are not actual standards: [G3.4a]
Your code includes the following standards which are not actual standards: [G3.2]
Your code includes the following standards which are not actual standards: [RE5.4]
Your code includes the following standards which are not actual standards: [RE8.1]
Your code includes the following standards which are not actual standards: [RE5.5]

Click to see the report of author-reported standards compliance of the package with links to associated lines of code, which can be re-generated locally by running the srr_report() function from within a local clone of the repository.


2. Package Dependencies

Details of Package Dependency Usage (click to open)

The table below tallies all function calls to all packages ('ncalls'), both internal (r-base + recommended, along with the package itself), and external (imported and suggested packages). 'NA' values indicate packages to which no identified calls to R functions could be found. Note that these results are generated by an automated code-tagging system which may not be entirely accurate.

type package ncalls
internal base 199
internal capybara 117
internal utils 49
internal grDevices 13
internal graphics 2
imports stats 95
imports magrittr 6
imports dplyr 4
imports MASS 4
imports ggplot2 2
imports Formula 1
imports kendallknight 1
imports rlang 1
suggests broom NA
suggests knitr NA
suggests rmarkdown NA
suggests testthat NA
suggests tidyr NA
suggests units NA
linking_to cpp11 NA
linking_to cpp11armadillo NA

Click below for tallies of functions used in each package. Locations of each call within this package may be generated locally by running 's <- pkgstats::pkgstats(<path/to/repo>)', and examining the 'external_calls' table.

base

for (12), list (10), drop (9), length (9), names (9), attr (8), nrow (8), abs (7), c (7), seq.int (7), mapply (6), matrix (6), max (6), beta (5), ncol (5), try (5), solve (4), sum (4), as.logical (3), cbind (3), class (3), data.frame (3), diag (3), getOption (3), lapply (3), rep (3), sqrt (3), structure (3), summary (3), trace (3), with (3), all (2), apply (2), integer (2), levels (2), nchar (2), Reduce (2), rownames (2), seq_len (2), vapply (2), as.data.frame (1), as.list (1), as.numeric (1), as.vector (1), colnames (1), colSums (1), crossprod (1), gamma (1), inherits (1), mean (1), order (1), paste0 (1), suppressWarnings (1), unlist (1), unname (1)

capybara

get_index_list_ (8), feglm_fit_ (3), fixed_effects (3), group_sums_ (3), nobs_ (3), partial_mu_eta_ (3), apes_bias_correction_ (2), apes_set_adj_ (2), bias_corr (2), center_variables_r_ (2), col_types (2), feglm (2), gamma_ (2), get_alpha_ (2), get_score_matrix_ (2), group_sums_cov_ (2), init_theta_ (2), summary_estimates_max_width_ (2), temp_var_ (2), apes (1), apes_adjust_covariance_ (1), apes_bias_check_binary_model_ (1), apes_bias_check_object_ (1), apes_bias_check_panel_ (1), augment.feglm (1), augment.felm (1), autoplot.feglm (1), autoplot.felm (1), bias_corr_check_fixed_effects_ (1), check_control_ (1), check_data_ (1), check_factor_ (1), check_family_ (1), check_formula_ (1), check_linear_dependence_ (1), check_response_ (1), check_weights_ (1), coef.apes (1), coef.feglm (1), coef.felm (1), coef.summary.apes (1), coef.summary.feglm (1), coef.summary.felm (1), confint.feglm (1), confint.felm (1), drop_by_link_type_ (1), feglm_control (1), feglm_offset_ (1), feglm_offset_fit_ (1), felm (1), fenegbin (1), fenegbin_check_convergence_ (1), fenegbin_result_list_ (1), fepoisson (1), fitted.feglm (1), fitted.felm (1), glance.feglm (1), glance.felm (1), group_sums_spectral_ (1), group_sums_var_ (1), model_frame_ (1), model_response_ (1), predict.feglm (1), predict.felm (1), print.apes (1), print.feglm (1), print.felm (1), print.summary.apes (1), print.summary.feglm (1), print.summary.felm (1), second_order_derivative_ (1), start_guesses_ (1), summary_estimates_ (1), summary_estimates_cols_ (1), summary_estimates_dashes_ (1), summary_estimates_header_ (1), summary_estimates_print_rows_ (1), summary_estimates_signif_ (1), summary_family_ (1), summary_fisher_ (1), summary_formula_ (1), summary.apes (1), summary.feglm (1), summary.felm (1), vcov_feglm_cluster_data_ (1), vcov_feglm_hessian_covariance_ (1), vcov_feglm_vars_ (1)

stats

family (30), formula (23), nobs (12), model.matrix (10), terms (5), deviance (3), pnorm (3), vcov (3), qnorm (2), weights (2), offset (1), poisson (1)

utils

data (48), combn (1)

grDevices

cm (13)

magrittr

%>% (6)

dplyr

all_of (2), select (2)

MASS

negative.binomial (2), theta.ml (2)

ggplot2

aes (1), ggplot (1)

graphics

pie (2)

Formula

Formula (1)

kendallknight

kendall_cor (1)

rlang

sym (1)


3. Statistical Properties

This package features some noteworthy statistical properties which may need to be clarified by a handling editor prior to progressing.

Details of statistical properties (click to open)

The package has:

  • code in C++ (29% in 7 files) and R (71% in 25 files)
  • 1 authors
  • 1 vignette
  • 1 internal data file
  • 9 imported packages
  • 18 exported functions (median 13 lines of code)
  • 192 non-exported functions in R (median 8 lines of code)
  • 51 R functions (median 5 lines of code)

Statistical properties of package structure as distributional percentiles in relation to all current CRAN packages
The following terminology is used:

  • loc = "Lines of Code"
  • fn = "function"
  • exp/not_exp = exported / not exported

All parameters are explained as tooltips in the locally-rendered HTML version of this report generated by the checks_to_markdown() function

The final measure (fn_call_network_size) is the total number of calls between functions (in R), or more abstract relationships between code objects in other languages. Values are flagged as "noteworthy" when they lie in the upper or lower 5th percentile.

measure value percentile noteworthy
files_R 25 85.3
files_src 7 93.6
files_vignettes 2 81.7
files_tests 14 91.6
loc_R 1633 77.6
loc_src 664 56.9
loc_vignettes 81 18.4
loc_tests 601 75.0
num_vignettes 1 58.8
data_size_total 285103 88.6
data_size_median 285103 95.4 TRUE
n_fns_r 210 89.1
n_fns_r_exported 18 63.8
n_fns_r_not_exported 192 91.8
n_fns_src 51 74.6
n_fns_per_file_r 5 67.4
n_fns_per_file_src 7 71.4
num_params_per_fn 3 29.4
loc_per_fn_r 8 24.5
loc_per_fn_r_exp 14 33.3
loc_per_fn_r_not_exp 8 23.0
loc_per_fn_src 5 11.5
rel_whitespace_R 21 80.5
rel_whitespace_src 31 71.5
rel_whitespace_vignettes 23 11.5
rel_whitespace_tests 31 81.6
doclines_per_fn_exp 53 65.9
doclines_per_fn_not_exp 0 0.0 TRUE
fn_call_network_size 194 87.5

3a. Network visualisation

Click to see the interactive network visualisation of calls between objects in package


4. goodpractice and other checks

Details of goodpractice checks (click to open)

3a. Continuous Integration Badges

R-CMD-check.yaml

GitHub Workflow Results

id name conclusion sha run_number date
11989684165 format_check success 5535f8 79 2024-11-23
11989684069 pages build and deployment success 5535f8 97 2024-11-23
11989684163 R-CMD-check success 5535f8 99 2024-11-23
11989684168 test-coverage success 5535f8 78 2024-11-23

3b. goodpractice results

R CMD check with rcmdcheck

R CMD check generated the following note:

  1. checking installed package size ... NOTE
    installed size is 13.2Mb
    sub-directories of 1Mb or more:
    libs 12.4Mb

R CMD check generated the following check_fail:

  1. rcmdcheck_reasonable_installed_size

Test coverage with covr

Package coverage: 80.44

Cyclocomplexity with cyclocomp

No functions have cyclocomplexity >= 15

Static code analyses with lintr

lintr found no issues with this package!


5. Other Checks

Details of other checks (click to open)

✖️ The following 4 function names are duplicated in other packages:

    • bias_corr from bife
    • feglm from alpaca
    • felm from lfe
    • fixed_effects from baggr, gratia, gravity


Package Versions

package version
pkgstats 0.2.0.48
pkgcheck 0.1.2.77
srr 0.1.3.26


Editor-in-Chief Instructions:

This package is in top shape and may be passed on to a handling editor

@emilyriederer
Copy link

@ropensci-review-bot assign @rkillick as editor

@ropensci-review-bot
Copy link
Collaborator

I'm sorry human, I don't understand that. You can see what commands I support by typing:

@ropensci-review-bot help

@emilyriederer
Copy link

@ropensci-review-bot help

@ropensci-review-bot
Copy link
Collaborator

Hello @emilyriederer, here are the things you can ask me to do:


# Add a review's info to the ROpenSci logs
@ropensci-review-bot submit review <REVIEW_URL> time <REVIEW_HOURS(ex. 10.5)>

# List all available commands
@ropensci-review-bot help

# Show our Code of Conduct
@ropensci-review-bot code of conduct

# Checks peer-review badge is in README.md
@ropensci-review-bot check readme

# Switch to 'seeking reviewers'
@ropensci-review-bot seeking reviewers

# Approves a package. This command will close the issue.
@ropensci-review-bot approve package-name

# Invite the author of a package to the corresponding rOpenSci team. This command should be issued by the author of the package.
@ropensci-review-bot invite me to ropensci/package-name

# Adds package's repo to the rOpenSci team. This command should be issued after approval and transfer of the package.
@ropensci-review-bot finalize transfer of package-name

# Mint package as [bronze/silver/gold]
@ropensci-review-bot mint silver

# Add a user to this issue's reviewers list
@ropensci-review-bot assign xxxxx as reviewer

# Remove a user from the reviewers list
@ropensci-review-bot remove xxxxx from reviewers

# Assign a user as the editor of this submission
@ropensci-review-bot assign @username as editor

# Put the submission on hold for the next 90 days
@ropensci-review-bot put on hold

# Remove the editor assigned to this submission
@ropensci-review-bot remove editor

# Change or add a review's due date for a reviewer
@ropensci-review-bot set due date for @reviewer to YYYY-MM-DD

# Close the issue
@ropensci-review-bot out of scope

# Various package checks
@ropensci-review-bot check package

# Checks srr documentation for stats packages
@ropensci-review-bot check srr

@emilyriederer
Copy link

@ropensci-review-bot assign @rkillick as editor

@ropensci-review-bot
Copy link
Collaborator

Assigned! @rkillick is now the editor

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

8 participants