search

IQSS / Zelig

A statistical framework that serves as a common interface to a large range of models
http://zeligproject.org
110 stars 43 forks source link

Doc update #281

Closed mbsabath closed 7 years ago

mbsabath commented 7 years ago

Updated Roxygen Documentation

christophergandrud commented 7 years ago

These warnings prevent the check's from passing on Travis and Appveyor (and would fail on CRAN):

0.36schecking Rd files ... WARNING
Zelig-factor-bayes-class.Rd: non-ASCII input and no declared encoding
Zelig-logit-bayes-class.Rd: non-ASCII input and no declared encoding
Zelig-mlogit-bayes-class.Rd: non-ASCII input and no declared encoding
Zelig-normal-bayes-class.Rd: non-ASCII input and no declared encoding
Zelig-poisson-bayes-class.Rd: non-ASCII input and no declared encoding
Zelig-probit-bayes-class.Rd: non-ASCII input and no declared encoding
Zelig-tobit-class.Rd: non-ASCII input and no declared encoding
problems found in ‘Zelig-factor-bayes-class.Rd’, ‘Zelig-logit-bayes-class.Rd’, ‘Zelig-mlogit-bayes-class.Rd’, ‘Zelig-normal-bayes-class.Rd’, ‘Zelig-poisson-bayes-class.Rd’, ‘Zelig-probit-bayes-class.Rd’, ‘Zelig-tobit-class.Rd’

They are likely caused by having copy and pasted characters from a non-text editor programme. They are often non-ASCII versions of ' and -. Please fixes and resubmit

mbsabath commented 7 years ago

They're either that, or copy and pasted greek letters from the vignettes' math notation. I can go in and fix those.

christophergandrud commented 7 years ago

Oh, yeah, greek letters aren't in ASCII. You have to use the LaTeX. Take a look actually in the slides from Wednesday on best practices, there is an example.

mbsabath commented 7 years ago

Also other fun things I found, turns out there's a funtion tools::showNonASCIIfile() that'll point you to the lines with the problem

mbsabath commented 7 years ago

ASCII characters are removed and changes are pushed

codecov-io commented 7 years ago

Codecov Report

Merging #281 into master will increase coverage by <.01%. The diff coverage is 100%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #281      +/-   ##
==========================================
+ Coverage   88.38%   88.38%   +<.01%     
==========================================
  Files          50       50              
  Lines        4115     4116       +1     
==========================================
+ Hits         3637     3638       +1     
  Misses        478      478
Impacted Files Coverage Δ
R/model-logit-bayes.R 100% <ø> (ø) :arrow_up:
R/model-normal-bayes.R 100% <ø> (ø) :arrow_up:
R/model-probit-bayes.R 100% <ø> (ø) :arrow_up:
R/model-tobit.R 98.41% <ø> (ø) :arrow_up:
R/model-ls.R 27.19% <ø> (ø) :arrow_up:
R/model-tobit-bayes.R 100% <ø> (ø) :arrow_up:
R/model-ma.R 100% <ø> (ø) :arrow_up:
R/model-factor-bayes.R 95.29% <ø> (ø) :arrow_up:
R/model-arima.R 90.99% <ø> (ø) :arrow_up:
R/model-ar.R 100% <ø> (ø) :arrow_up:
... and 4 more

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update 66bd0ba...12bd37d. Read the comment docs.

mbsabath commented 7 years ago

The man files are updated, pkg-down is run, check returns no errors or warnings, and the spare $$ signs are removed from the vignettes.