Download and Parse Public Data Released by B3 Exchange #534
Comments
|
Thanks for submitting to rOpenSci, our editors and @ropensci-review-bot will reply soon. Type |
|
Error (500). The editorcheck service is currently unavailable |
Checks for rb3 (v0.0.3)git hash: cbb35b8a
Important: All failing checks above must be addressed prior to proceeding Package License: MIT + file LICENSE 1. Package DependenciesDetails 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.
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. baselist (40), class (16), for (10), if (10), c (9), lapply (9), format (8), is.null (7), names (7), url (7), attr (6), F (6), length (6), as.Date (5), colnames (5), do.call (5), paste0 (4), structure (4), UseMethod (4), by (3), file.path (3), readLines (3), seq (3), as.data.frame (2), as.integer (2), body (2), match (2), options (2), parent.frame (2), Reduce (2), seq_along (2), sign (2), strptime (2), sub (2), sum (2), Sys.Date (2), table (2), try (2), as.character (1), as.numeric (1), as.POSIXct (1), basename (1), charToRaw (1), data.frame (1), dim (1), environment (1), evalq (1), exists (1), get (1), gsub (1), missing (1), order (1), print (1), rbind (1), rep (1), strftime (1), switch (1), t (1), tempdir (1) rb3handler (30), fields (11), server (6), download_data (5), width (5), composite (4), match_regex (4), retrieve_template (4), transmuter (4), get (3), query_cdi (3), read_fwf (3), read_marketdata (3), take (3), cachedir (2), code2month (2), fields_description (2), fields_handlers (2), fields_names (2), fields_widths (2), flatten_names (2), iter_rules (2), pass_thru_handler (2), rule_result (2), show_templates (2), unformat (2), apply_rule (1), apply_rule.class_rule (1), apply_rule.predicate_rule (1), apply_rule.regex_rule (1), as_dbl (1), as.data.frame.fields (1), cdi_get (1), clearcache (1), convert_to (1), cotahist_bdrs_get (1), cotahist_equity_get (1), cotahist_equity_options_get (1), cotahist_funds_get (1), cotahist_funds_options_get (1), cotahist_get (1), cotahist_index_options_get (1), cotahist_indexes_get (1), cotahist_units_get (1), cotahist_units_options_get (1), csv_read_file (1), curve_download (1), curve_read (1), datetime_download (1), display_template (1), field (1), fields_description.fields (1), fields_handlers.fields (1), fields_names.fields (1), fields_widths.fields (1), filter_equity_data (1), format_equity (1), format_options (1), futures_get (1), futures_mget (1), fwf_read_file (1), get_single_yc (1), idi_get (1), json_read_file (1), just_download_data (1), keys (1), match_class (1), match_predicate (1), maturity2date (1), mcsv_read_file (1), mfwf_read_file (1), new_field (1), new_part (1), options_open_interest_read (1), parse_columns (1), print.fields (1), print.parts (1), put (1), register (1), save_resource (1), settlement_prices_download (1), settlement_prices_read (1), simple_download (1), single_futures_get (1), stock_indexes_composition_download (1), stock_indexes_composition_reader (1), to_dbl (1), unzip_recursive (1) statsdf (25), pt (1) utilsdata (15), read.table (2), methods (1), unzip (1) graphicstext (10), lines (5) methodssetGeneric (4), as (3), is (3), representation (2), initialize (1), setRefClass (1) httrcontent (3), GET (3), parse_url (2), POST (1) purrrmap_chr (5), map_lgl (3), map_int (1) shinydialogViewer (4), runGadget (2), shinyApp (2), h3 (1) stringrstr_replace (2), str_sub (2), str_detect (1), str_match (1), str_pad (1) jsonlitefromJSON (3), toJSON (2) bizdaysbizseq (2), add.bizdays (1), bizdayse (1) protoproto (4) rvestread_html (2), html_element (1), html_table (1) dplyrbind_rows (2), tibble (1) miniUIminiPage (2) readrread_file (1), read_rds (1) asciiascii (1) base64encbase64encode (1) digestdigest (1) 2. Statistical PropertiesThis 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:
Statistical properties of package structure as distributional percentiles in relation to all current CRAN packages
All parameters are explained as tooltips in the locally-rendered HTML version of this report generated by the The final measure (
2a. Network visualisationClick to see the interactive network visualisation of calls between objects in package 3.
|
| id | name | conclusion | sha | run_number | date |
|---|---|---|---|---|---|
| 2306339093 | pages build and deployment | success | 38384b | 33 | 2022-05-11 |
| 2306316808 | pkgdown | success | cbb35b | 36 | 2022-05-11 |
| 2306316813 | R-CMD-check | success | cbb35b | 54 | 2022-05-11 |
| 2306316802 | test-coverage | success | cbb35b | 54 | 2022-05-11 |
3b. goodpractice results
R CMD check with rcmdcheck
R CMD check generated the following check_fail:
- no_import_package_as_a_whole
Test coverage with covr
Package coverage: 74.58
Cyclocomplexity with cyclocomp
No functions have cyclocomplexity >= 15
Static code analyses with lintr
lintr found the following 3 potential issues:
| message | number of times |
|---|---|
| Lines should not be more than 80 characters. | 3 |
Package Versions
| package | version |
|---|---|
| pkgstats | 0.0.4.30 |
| pkgcheck | 0.0.3.19 |
Editor-in-Chief Instructions:
Processing may not proceed until the items marked with ✖️ have been resolved.
|
@msperlin The build failure in the checks above is because That generally means you're not locally using latest versions of all dependency packages. Please let us know when you've fixed that, and the other issues identified above. Thanks. Edit: I see that it was actually our system which needed updating to the new |
|
Hello @msperlin and many thanks for your submission. We are discussing whether the package is in scope and need a bit more information. I see you are the author of other packages such as GetDFDData2 already on CRAN. Could you please help to clarify the differences between these two packages? Is the former focused only on financial statements whereas this package provides more granular time series? While I'm sure your two packages are not "competing", I want to fully understand what makes this package novel and how it is best in class. Similarly, I see a B3 data listed on general services like Yahoo Finance which I know can be accessed through a number of packages including Thank you! |
|
Please find my replies below:
The different between GetDFPDAta2 and rb3 is in their scope and audience. Package GetDFPData2 is related to financial documents released by companies to the exchange and its audience is mostly business analysts. This includes sales, profit, and many other financial information on a annual basis. Meanwhile, you cant think of rb3 as an interface to all trade data available at the b3 website, including prices of many different type of contracts such as options, equities (companies) and futures. ITs audience is more related to traders and market participants. While there is some relationship between datasets from rb3 (stock prices) and GetDFPData2 (financial statements) for equities, there is none for other types of markets.
The data is indeed simillar, but only for equities (companies). Yahoo finance, for example, does not provide historical prices for futures or option contracts. Package rb3 also provides access to historical yield curves, which is a very unique (and rare) set of data in finance. |
|
@wilsonfreitas I just fixed the code for codemeta and contributing file. The other problems are deeper in the code. Can you please have a look? |
|
Hi @emilyriederer and @msperlin I added the examples to the functions show_templates and display_templates. And with respect to |
|
Furtherly, the test coverage is now 84%. |
|
Thanks @wilsonfreitas, our check system has just been updated to do what above link says: Allow global assignment operator if in RefClass statement. Your package no longer fails that check 👍 And FYI, another new check has just been added which in your case reports this: 4. Other Checks✖️ The following function name is duplicated in other packages:
That's currently a "trial" function so you don't necessarily need to respond, but feel free to change the name if you want. |
|
Hi @mpadge
This is great!
|
|
@ropensci-review-bot check package |
|
Thanks, about to send the query. |
|
🚀 Editor check started 👋 |
Checks for rb3 (v0.0.3)git hash: e7aa4be0
Important: All failing checks above must be addressed prior to proceeding Package License: MIT + file LICENSE 1. Package DependenciesDetails 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.
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. baselist (40), class (16), for (10), if (10), c (9), lapply (9), format (8), is.null (7), names (7), url (7), attr (6), F (6), length (6), as.Date (5), colnames (5), do.call (5), paste0 (4), structure (4), by (3), file.path (3), readLines (3), seq (3), seq_along (3), as.data.frame (2), as.integer (2), body (2), match (2), options (2), parent.frame (2), Reduce (2), sign (2), strptime (2), sub (2), sum (2), Sys.Date (2), table (2), try (2), as.character (1), as.numeric (1), as.POSIXct (1), basename (1), charToRaw (1), data.frame (1), dim (1), environment (1), evalq (1), exists (1), get (1), gsub (1), missing (1), order (1), print (1), rbind (1), rep (1), row.names (1), strftime (1), switch (1), t (1), tempdir (1) rb3handler (30), fields (11), server (6), download_marketdata (5), width (5), composite (4), match_regex (4), retrieve_template (4), transmuter (4), get (3), query_cdi (3), read_fwf (3), read_marketdata (3), take (3), cachedir (2), code2month (2), fields_description (2), fields_handlers (2), fields_names (2), fields_widths (2), flatten_names (2), iter_rules (2), pass_thru_handler (2), rule_result (2), show_templates (2), unformat (2), apply_rule (1), apply_rule.class_rule (1), apply_rule.predicate_rule (1), apply_rule.regex_rule (1), as_dbl (1), as.data.frame.fields (1), cdi_get (1), clearcache (1), convert_to (1), cotahist_bdrs_get (1), cotahist_equity_get (1), cotahist_equity_options_get (1), cotahist_funds_get (1), cotahist_funds_options_get (1), cotahist_get (1), cotahist_index_options_get (1), cotahist_indexes_get (1), cotahist_units_get (1), cotahist_units_options_get (1), csv_read_file (1), curve_download (1), curve_read (1), datetime_download (1), display_template (1), field (1), filter_equity_data (1), format_equity (1), format_options (1), futures_get (1), futures_mget (1), fwf_read_file (1), get_single_yc (1), idi_get (1), json_read_file (1), just_download_data (1), keys (1), match_class (1), match_predicate (1), maturity2date (1), mcsv_read_file (1), mfwf_read_file (1), new_field (1), new_part (1), options_open_interest_read (1), parse_columns (1), print.fields (1), print.parts (1), put (1), register (1), save_resource (1), settlement_prices_download (1), settlement_prices_read (1), simple_download (1), single_futures_get (1), stock_indexes_composition_download (1), stock_indexes_composition_reader (1), to_dbl (1), unzip_recursive (1) statsdf (25), pt (1) utilsdata (15), read.table (2), methods (1), unzip (1) graphicstext (10), lines (5) methodssetGeneric (4), as (3), is (3), representation (2), initialize (1), setRefClass (1) httrcontent (3), GET (3), parse_url (2), POST (1) purrrmap_chr (5), map_lgl (3), map_int (1) shinydialogViewer (4), runGadget (2), shinyApp (2), h3 (1) stringrstr_replace (2), str_sub (2), str_detect (1), str_match (1), str_pad (1) jsonlitefromJSON (3), toJSON (2) bizdaysbizseq (2), add.bizdays (1), bizdayse (1) protoproto (4) rvestread_html (2), html_element (1), html_table (1) dplyrbind_rows (2), tibble (1) miniUIminiPage (2) readrread_file (1), read_rds (1) asciiascii (1) base64encbase64encode (1) digestdigest (1) 2. Statistical PropertiesThis 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:
Statistical properties of package structure as distributional percentiles in relation to all current CRAN packages
All parameters are explained as tooltips in the locally-rendered HTML version of this report generated by the The final measure (
2a. Network visualisationClick to see the interactive network visualisation of calls between objects in package 3.
|
| id | name | conclusion | sha | run_number | date |
|---|---|---|---|---|---|
| 2319766131 | pages build and deployment | success | 452491 | 41 | 2022-05-13 |
| 2319747523 | pkgdown | success | e7aa4b | 44 | 2022-05-13 |
| 2319747525 | R-CMD-check | success | e7aa4b | 63 | 2022-05-13 |
| 2319747522 | test-coverage | success | e7aa4b | 63 | 2022-05-13 |
3b. goodpractice results
R CMD check with rcmdcheck
R CMD check generated the following check_fail:
- no_import_package_as_a_whole
Test coverage with covr
Package coverage: 85.34
Cyclocomplexity with cyclocomp
No functions have cyclocomplexity >= 15
Static code analyses with lintr
lintr found the following 11 potential issues:
| message | number of times |
|---|---|
| Avoid using sapply, consider vapply instead, that's type safe | 3 |
| Lines should not be more than 80 characters. | 8 |
Package Versions
| package | version |
|---|---|
| pkgstats | 0.0.4.30 |
| pkgcheck | 0.0.3.19 |
Editor-in-Chief Instructions:
Processing may not proceed until the items marked with ✖️ have been resolved.
|
Thanks for the answers on the package uniqueness, @msperlin . I really appreciate the additional context on the package's unique value. I will proceed to look for editors for this package. Would you mind adding more details and context to the README? After reading it someone with little domain knowledge should have been informed about the aim, goals and functionality of the package. |
|
Thanks @emilyriederer. I added to the README.md the explicit datasets available at rb3. This should give context to the reader and set rb3 apart from other packages. |
|
Hello again, @msperlin ! Thanks for updating the README. I noticed that you are also currently going through active review for As such, I am going to apply the |
|
No problem @emilyriederer. Makes sense to me. |
|
@ropensci-review-bot put on hold |
|
Submission on hold! |
|
@maelle: Please review the holding status |
|
@msperlin do you still intend to submit this package? |
|
Hi @maelle, @wilsonfreitas is the main author of the package and has done far more work on the code than myself. I believe the decision should be his. |
emilyriederer
added
5/awaiting-reviewer(s)-response
and removed
holding
4/review(s)-in-awaiting-changes
labels
|
Hi there @pachadotdev and @quishqa ! Could you please take a look an @wilsonfreitas 's changes and complete the approval template? Thank you! |
|
Hi @pachadotdev and @quishqa - happy new year! I know my last message might have been poorly timed around the holidays. Would you have time soon to do a final review and approval of @wilsonfreitas 's updates? Thank you! |
|
Hi all! |
|
Hi @quishqa, thanks for your reply. |
hi! |
|
Thanks for checking in @quishqa and @pachadotdev ! Once @wilsonfreitas has the checks back, can you both please formally sign off with the template? |
|
Hi @pachadotdev and @quishqa, all RMD checks are passing. |
Hi @emilyriederer |
|
@quishqa - Yes, perfect! Thanks. (cc-ing @pachadotdev as well) |
Reviewer ResponseFinal approval (post-review)
Estimated hours spent reviewing: 7 |
Package ReviewPlease check off boxes as applicable, and elaborate in comments below. Your review is not limited to these topics, as described in the reviewer guide
DocumentationThe package includes all the following forms of documentation:
Functionality
Estimated hours spent reviewing: 3
Review CommentsGood! |
|
@ropensci-review-bot approve rb3 |
|
Approved! Thanks @msperlin for submitting and @pachadotdev, @quishqa for your reviews! 😁 To-dos:
Should you want to acknowledge your reviewers in your package DESCRIPTION, you can do so by making them 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 @ropensci/blog-editors in your reply. They will get in touch about timing and can answer any questions. We maintain an online book with our best practice and tips, this chapter starts the 3d section that's about guidance for after onboarding (with advice on releases, package marketing, GitHub grooming); the guide also feature CRAN gotchas. Please tell us what could be improved. Last but not least, you can volunteer as a reviewer via filling a short form. |
|
Congratulations, @wilsonfreitas ! Yuur package has been approved. There's a lot of great information above about how you can fully transfer the package to rOpenSci and some (optional) ideas for marketing. Would you also be interested in writing a blog post about your package? I think it's always great to feature new data packages in posts since it can raise awareness both for the package and for new underlying APIs that folks may not know about. Additionally, I think there are a lot of synergies between this package and other @msperlin and @pachadotdev submissions, so we could even explore those interactions. If so, @ropensci/blog-editors can provide more detail. |
|
@wilsonfreitas @msperlin did you meet any difficulty? I'm asking as I'm drafting rOpenSci newsletter I'll send on Friday: if your package is transferred by then, it will be mentioned in this month's newsletter (if not, in next month's so no worries). |
|
Thanks @maelle. I belive only @wilsonfreitas can change the ownership of the repository. |
|
@ropensci-review-bot invite me to ropensci/rb3 |
|
I am trying to transfer the repo to ropensci, but I don't have the permission.
Am I doing it correctly? |
|
@wilsonfreitas I've now invited you to the GitHub organization, can you please try again? I've just realized this submission is a scenario we hadn't thought of: the submitter @msperlin didn't own the repository, and we send the organization invitation to the submitter. 😅 Sorry about the resulting clunkiness! |
|
In the end the repo was transferred riiight before I sent the newsletter (in a few minutes), well done 🏆 😉 |
|
@ropensci-review-bot finalize transfer of ropensci/rb3 |
|
Could not finalize transfer: Could not add owner rights to the |
|
@wilsonfreitas @msperlin you're now both part of a team with admin access to the repo. |
Date accepted: 2023-02-08
Submitting Author Name: Marcelo S. Perlin
Due date for @pachadotdev: 2022-10-16Submitting Author Github Handle: @msperlin
Other Package Authors Github handles: (comma separated, delete if none) @wilsonfreitas
Repository: https://github.com/wilsonfreitas/rb3
Version submitted: 0.0.3
Submission type: Standard
Editor: @emilyriederer
Reviewers: @pachadotdev, @quishqa
Due date for @quishqa: 2022-10-24
Archive: TBD
Version accepted: TBD
Language: en
Scope
Please indicate which category or categories from our package fit policies this package falls under: (Please check an appropriate box below. If you are unsure, we suggest you make a pre-submission inquiry.):
Explain how and why the package falls under these categories (briefly, 1-2 sentences):
The package downloads and organizes raw financial data directly from B3, the main financial exchange in Brazil. These datasets are not available in any other way.
Academic researchers and practioners of financial markets.
No.
Yes.
If you made a pre-submission inquiry, please paste the link to the corresponding issue, forum post, or other discussion, or @tag the editor you contacted.
Explain reasons for any
pkgcheckitems which your package is unable to pass.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?
Do you wish to submit an Applications Article about your package to Methods in Ecology and Evolution? If so:
MEE Options
Code of conduct
The text was updated successfully, but these errors were encountered: