Closed wfrierson closed 3 years ago
noamross
commented
3 years ago Thank you for the pre-submission, @wfrierson! We consider this in-scope and welcome a full submission. We consider it a data retrieval and munging package as much as anything as it eases access to this data and performs common data processing steps specific to the data on top of that.
mpadge
commented
3 years ago @wfrierson A re-submission will now automatically respond with standard package checks. Documentation for these is forthcoming, so until then could you please install our pgkcheck package and run the following prior to full submission:
x <- pkgcheck("<path>/<to>/wmm")
summary(x)That will clarify any remaining issues which you can address prior to submission. Thanks!
wfrierson
commented
2 years ago Thanks, @mpadge. I'm trying to install pkgcheck. However, it just won't install.
I'm using Windows (R 3.6.1). When first trying to install pkgcheck, I compile from source using Rtools v3.5.0.4. It errors out saying pkgstats and ssr need to be installed (with extremely long compilation output). I try compiling from source pkgstats and get the output below. I'm stumped. Do I really need to run pkgcheck before submitting, especially if I can't install pkgcheck?
installing source package 'pkgstats' ... ** using staged installation
WARNING: this package has a configure script It probably needs manual configuration
** libs
* arch - i386
mkdir -p ../inst
"C:/PROGRA~1/R/R-36~1.1/bin/i386/Rscript.exe" --vanilla "../tools/winlibs.R"
cp -rf ../windows/universal-ctags-5.9.20210530.0/bin ../inst/
C:/Rtools/mingw_32/bin/g++ -std=gnu++11 -I"C:/PROGRA~1/R/R-36~1.1/include" -DNDEBUG -I"C:/Users/willf/Documents/R/win-library/3.6/cpp11/include" -O2 -Wall -mtune=generic -c code-symbols.cpp -o code-symbols.o
C:/Rtools/mingw_32/bin/g++ -std=gnu++11 -I"C:/PROGRA~1/R/R-36~1.1/include" -DNDEBUG -I"C:/Users/willf/Documents/R/win-library/3.6/cpp11/include" -O2 -Wall -mtune=generic -c cpp11.cpp -o cpp11.o
cpp11.cpp:9:1: error: reference to 'writable' is ambiguous
writable::integers cpp_loc(const strings flist, const strings cmt_open, const strings cmt_close, const strings cmt);
^
In file included from cpp11.cpp:5:0:
C:/Users/willf/Documents/R/win-library/3.6/cpp11/include/cpp11/declarations.hpp:9:39: note: candidates are: namespace writable = cpp11::cpp11::writable;
namespace writable = ::cpp11::writable;
^
In file included from C:/Users/willf/Documents/R/win-library/3.6/cpp11/include/cpp11/list.hpp:10:0,
from C:/Users/willf/Documents/R/win-library/3.6/cpp11/include/cpp11/data_frame.hpp:12,
from C:/Users/willf/Documents/R/win-library/3.6/cpp11/include/cpp11.hpp:7,
from C:/Users/willf/Documents/R/win-library/3.6/cpp11/include/cpp11/declarations.hpp:8,
from cpp11.cpp:5:
C:/Users/willf/Documents/R/win-library/3.6/cpp11/include/cpp11/r_vector.hpp:44:20: note: namespace cpp11::writable { }
namespace writable {
^
cpp11.cpp:9:1: error: 'writable' does not name a type
writable::integers cpp_loc(const strings flist, const strings cmt_open, const strings cmt_close, const strings cmt);
^
cpp11.cpp: In function 'SEXPREC _pkgstats_cpp_loc(SEXP, SEXP, SEXP, SEXP)':
cpp11.cpp:12:250: error: 'cpp_loc' was not declared in this scope
return cpp11::as_sexp(cpp_loc(cpp11::as_cpp<cpp11::decay_t
mpadge
commented
2 years ago @wfrierson You don't strictly need to run pkgcheck, but it is certainly very helpful to ensure your package has met all pre-submission criteria. If you can't get it to work locally, you could try using the pkgcheck-action GitHub action to run the checks on GitHub. Alternatively, you just have to ensure you read the Dev Guide very carefully and address every single requirement described there.
Submitting Author: Will Frierson (@wfrierson)
Repository: https://github.com/wfrierson/wmm Submission type: Pre-submission
Scope
Please indicate which category or categories from our package fit policies or statistical package categories this package falls under. (Please check an appropriate box below):
Data Lifecycle Packages
[ ] data retrieval
[ ] data extraction
[ ] database access
[ ] data munging
[ ] data deposition
[ ] workflow automation
[ ] version control
[ ] citation management and bibliometrics
[X] scientific software wrappers
[ ] database software bindings
[ ] geospatial data
[ ] text data
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
Explain how and why the package falls under these categories (briefly, 1-2 sentences). Please note any areas you are unsure of: The
wmmR package is a tool for scientists who need magnetic field vector value predictions at certain locations and times (consistent with the official test values from NOAA) . The package has 1 exported function,GetMagneticFieldWMM, which provides magnetic field components described on the repo's README. This seems consistent with "scientific software wrappers."If submitting a statistical package, have you already incorporated documentation of standards into your code via the srr package? n/a
Who is the target audience and what are scientific applications of this package?
Any role that requires magnetic field vector value predictions in the scope of the coefficients provided by NOAA, e.g., geophysicists and navigators.
Are there other R packages that accomplish the same thing? If so, how does yours differ or meet our criteria for best-in-category? I have not found any R packages that offer the same output given a location and time. The most similar package is oce, which offers the function
magneticFieldthat returns a "list containing declination, inclination, and intensity." In comparison, thewmmpackage returns the orthogonal vector components of the main magnetic field, secular variation field, and other magnetic field elements (see the repo's README for details).(If applicable) Does your package comply with our guidance around Ethics, Data Privacy and Human Subjects Research? N/A, since the only data derived from measurements are Gauss coefficients provided by NOAA.
Any other questions or issues we should be aware of?: Notes: 1) I am not affiliated with NOAA and this was a personal project. The package uses Gauss coefficients provided by NOAA. I have shown them the package and they recently added it to their 3rd party software page for R. 2) The unit tests for the package compare calculated with official magnetic field values for certain locations and times. The package uses travis-ci to perform automatic unit testing with each commit.