ropenscilabs / statistical-software-review

Experiments for rOpenSci's project for peer review of statistical software
1 stars 0 forks source link

test submission #7

Open mpadge opened 3 years ago

mpadge commented 3 years ago

Submitting Author: Mark Padgham (@mpadge) Repository: https://github.com/mpadge/fastadi-demo Version submitted: Editor: !--editor-->@mpadge<!--end-editor-- Reviewers: !--reviewers-list-->@adamhsparks<!--end-reviewers-list--

Due date for @adamhsparks: 2021-06-12

Archive: TBD Version accepted: TBD


Implements the AdaptiveImpute matrix completion
algorithm of 'Intelligent Initialization and Adaptive Thresholding 
Iterative Matrix Completion',
<https://amstat.tandfonline.com/doi/abs/10.1080/10618600.2018.1518238>.
AdaptiveImpute is useful for embedding sparsely observed matrices,
often out performs competing matrix completion algorithms, and
self-tunes its hyperparameter, making usage easy.

General Information

Badging

Technical checks

Confirm each of the following by checking the box.

This package:

Publication options

Code of conduct

mpadge commented 3 years ago

@ropensci-review-bot help

ropensci-review-bot commented 3 years ago

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


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

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

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

# Approve the package
@ropensci-review-bot approve

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

# 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

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

# Close the issue
@ropensci-review-bot approve

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

# Check whether a package is good to send out to review
@ropensci-review-bot goodtoreview
mpadge commented 3 years ago

@ropensci-review-bot check package

mpadge commented 3 years ago

Checks for fastadi (v0.0.0.9019)

git hash: c207f3b8

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

Package License: MIT + file LICENSE


1. srr

This package is in the following category: Dimensionality Reduction, Clustering and Unsupervised Learning

Click here to view output of 'srr_report', which can be re-generated locally by running the `srr_report() function from within a local clone of the repository.


2. Statistical Properties

The statistical properties of this package are all within normal ranges.

click to see

The package has: - Code in R (69%, in 10 files) and C++ (31%, in 7 files) - 4 Authors - 3 Vignettes - No internal data - 6 imported packages - 9 exported functions (median 25 lines of code) - 63 non-exported functions in R (median 5 lines of code) - 13 C++ functions (median 15 lines of code) - No C++ `class` or `struct` objects --- 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 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 | 10| 55.4| | |files_vignettes | 4| 94.3| | |files_tests | 12| 90.6| | |loc_R | 597| 50.2| | |loc_vignettes | 617| 89.2| | |loc_tests | 396| 67.3| | |loc_per_fn_r | 6| 22.7| | |loc_per_fn_r_exp | 25| 57.6| | |loc_per_fn_r_not_exp | 5| 17.3| | |loc_per_fn_src | 15| 57.2| | |num_params_per_fn | 6| 79.2| | |loc_per_fn_r | 6| 22.7| | |loc_per_fn_r_exp | 25| 57.6| | |loc_per_fn_r_not_exp | 5| 17.3| | |loc_per_fn_src | 15| 57.2| | |fn_call_network_size | 30| 49.9| | ---

2a. Network visualisation

Click here for interactive network visualisation of calls between objects in package.


3. goodpractice and other checks

Click to see

### 3a. Continuous Integration Badges [![github](https://github.com/RoheLab/fastadi/workflows/R-CMD-check/badge.svg)](https://github.com/mpadge/fastadi-demo/actions) **GitHub Workflow Results** |name |conclusion |sha |date | |:-------------|:----------|:------|:----------| |Commands |skipped |694594 |2021-01-04 | |pkgdown |failure |4fc3b6 |2021-03-17 | |R-CMD-check |failure |4fc3b6 |2021-03-17 | |test-coverage |failure |4fc3b6 |2021-03-17 | ---- ### 3b. `goodpractice` results --- ### Test coverage ([`covr`](https://github.com/jimhester/covr)) - :heavy_check_mark: Package coverage is 78.8% - :heavy_multiplication_x: The following files have coverage < 75%: - `R/fastadi-package.R` (0.00%), - `R/generative-model.R` (0.00%) - `R/object.R` (30.00%) --- ### Cyclomatic Complexity ([`cyclocomp`](https://github.com/MangoTheCat/cyclocomp)) - :heavy_check_mark: Maximal cyclomatic complexity is 13 (`adaptive_impute`, `citation_impute`) --- ### R CMD check ([`rcmdcheck`](https://github.com/r-lib/rcmdcheck)) R CMD check generated the following warning: ``` 1. checking Rd cross-references ... WARNING Missing link or links in documentation object 'adaptive_impute.Rd': ‘stat’ See section 'Cross-references' in the 'Writing R Extensions' manual. ``` In addition, the following tests failed: - `no_description_depends` - `no_import_package_as_a_whole` - `rcmdcheck_rd_cross_references` --- ### Code linting ([`lintr`](https://github.com/jimhester/lintr)) [`lintr`](https://github.com/jimhester/lintr) observed potential issues with code style in 106 lines ---

Editor-in-Chief Instructions:

Processing may not proceed until the items in the top section marked with :heavy_multiplication_x: have been resolved (other items in subsequent sub-sections may be ignored for moment at your discretion).

mpadge commented 3 years ago

@ropensci-review-bot goodtoreview

ropensci-review-bot commented 3 years ago

Thanks, about to check whether the package is review-ready

ropensci-review-bot commented 3 years ago

:rocket:

Handling Editor Instructions:

This package is a great shape! Please proceed to finding reviewers.

:wave:

mpadge commented 3 years ago

@ropensci-review-bot assign @mpadge as editor

ropensci-review-bot commented 3 years ago

Assigned! @mpadge is now editor. Please review the package check details, comment on any areas for reviewers to focus on, and assign reviewers when ready”

mpadge commented 3 years ago

@ropensci-review-bot add @noamross to reviewers

ropensci-review-bot commented 3 years ago

@noamross added to the reviewers list. Review due date is 2021-05-24. Thanks @noamross for accepting to review! Please refer to our reviewer guide.

mpadge commented 3 years ago

Package Review

Please check off boxes as applicable, and elaborate in comments below. Your review is not limited to these topics, as described in the reviewer guide


Compliance with Standards

The following standards currently deemed non-applicable (through tags of @srrstatsNA) could potentially be applied to future versions of this software:

Please also comment on any standards which you consider either particularly well, or insufficiently, documented.

For packages aiming for silver or gold badges:

It complies with a lot of standards.


General Review

Documentation

The package includes all the following forms of documentation:

The following sections of this template include questions intended to be used as guides to provide general, descriptive responses. Please remove this, and any subsequent lines that are not relevant or necessary for your final review.

Algorithms

Testing

Visualisation (where appropriate)

Package Design


Estimated hours spent reviewing:

mpadge commented 3 years ago

@ropensci-review-bot approve silver

mpadge commented 3 years ago

Approved! Thanks @{{issue_author}} for submitting and {{reviewers-list}} for your reviews! :grin:

To-dos:

Should you want to acknowledge your reviewers in your package DESCRIPTION, you can do so by making them "rev"-type contributors in the Authors@R field (with their consent). More info on this here.

Welcome aboard! We'd love to host a post about your package - either a short introduction to it with an example for a technical audience or a longer post with some narrative about its development or something you learned, and an example of its use for a broader readership. If you are interested, consult the blog guide, and tag @stefaniebutland in your reply. She will get in touch about timing and can answer any questions.

We've put together an online book with our best practice and tips, this chapter starts the 3d section that's about guidance for after onboarding. Please tell us what could be improved, the corresponding repo is here.

Last but not least, you can volunteer as a reviewer via filling a short form.

mpadge commented 3 years ago

@ropensci-review-bot remove @noamross from reviewers

ropensci-review-bot commented 3 years ago

@noamross removed from the reviewers list!

mpadge commented 3 years ago

@ropensci-review-bot add @adamhsparks to reviewers

ropensci-review-bot commented 3 years ago

@adamhsparks added to the reviewers list. Review due date is 2021-06-12. Thanks @adamhsparks for accepting to review! Please refer to our reviewer guide.

mpadge commented 2 years ago

@ropensci-review-bot help

ropensci-review-bot commented 2 years ago

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


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

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

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

# Approve the package
@ropensci-review-bot approve

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

# 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

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

# Close the issue
@ropensci-review-bot approve

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

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