Vignettes/58

[moralapablo]

This PR covers several topics that were related or appeared while updating and reviewing all the docs and vignettes. The main changes can be summarized as follows:

• Documentation improvements, adding missing information, examples, details, etc. This closes Documentation improvements #57.
• Renamed eval_poly() x argument to newdata
• Vignettes revamp, with new structure removing duplicates, mainly by having a single vignette listing the details of each DL supported framework. This closes Vignette improvements #58.
• Fixed a problem with the intercept coefficient in eval_poly() which closes Fix intercept (0) check in eval_poly() #63.
• Reordered nn2poly() and predict() outputs to represent polynomials in columns instead of rows for consistency with other predict functions. This closes Switch columns by rows in nn2poly() and predict() outputs #66.
• Changed output structure in nn2poly() and predict() when using keep_layers=TRUE, which closes Output format for nn2poly(keep_layers = TRUE) and predict(). #64. Furthermore, choosing specific layers when predicting is now supported.
• Mac tests involving torch are now skipped due to an external fail in GitHub Actions Testing problems with torch in mac #65.

[codecov-commenter]

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (e6daded) 83.16% compared to head (20ba923) 79.93%.
Report is 1 commits behind head on master.

❗ Current head 20ba923 differs from pull request most recent head 269aee7. Consider uploading reports for the commit 269aee7 to get more accurate results

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files

@@            Coverage Diff             @@
##           master      #67      +/-   ##
==========================================
- Coverage   83.16%   79.93%   -3.24%     
==========================================
  Files          16       16              
  Lines         606      648      +42     
==========================================
+ Hits          504      518      +14     
- Misses        102      130      +28     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[Enchufa2]

I fixed a couple of NOTEs: detritus in temp dir and the "figure" thing (it seems that there was a specific test for this name after all, so... changed to "includes").

A couple of comments:

• Some examples are required for add_constraints and luz_model_sequential.
• I don't remember if we talked about maintaining the Rd for eval_poly or adding @noRd instead.

And don't worry about the failing check in r-devel. It's an Rcpp issue and will be fixed with the next release in a few days.

[Enchufa2]

Checks fixed thanks to the new version of Rcpp.

[moralapablo]

Added missing examples for add_constraints() and luz_sequential_model().

• I don't remember if we talked about maintaining the Rd for eval_poly or adding @noRd instead.

We talked about maintaining it temporarily as it is used to define some of data in the vignettes. A warning about it being subject to change and not exported is mentioned in the details section of its documentation.