Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

edits to argument and column glossaries #26

Merged
merged 5 commits into from
May 28, 2020
Merged

edits to argument and column glossaries #26

merged 5 commits into from
May 28, 2020

Conversation

simonpcouch
Copy link
Collaborator

An addition to the argument glossary for tidy() for merging of tidymodels/broom#833.🙂

@simonpcouch
Copy link
Collaborator Author

simonpcouch commented May 22, 2020 •
edited
Loading

Adding on to this PR with some documentation of value columns outputted by tidy() methods. Some notes on what different value columns mean in broom to justify the definition:

  • in stats::ts tidiers - value of estimate/variable (type given in series) (results from data reshaping)
  • in ks tidiers - value of estimate/variable (type given in variable) (results from data reshaping)
  • in zoo tiders - value of estimate/variable (type given in series) (results from data reshaping)
  • in optim tidiers - the $value element of the input x: “The value of fn corresponding to par” (best optimized value)
  • in svd tidiers - value of estimate (type given in PC) (results from data reshaping)

I've written the definition to try to describe all but optim, and will add that documentation manually.

EDIT: About to add more column definitions:

For the row column:

  • in stats-pr-comp - “Row ID of the original observation”
  • in svd - same as stats-pr-comp

For the n column:

  • in pyears: “number of subjects contributing time"
  • in survival-cch : "number of predictions"
  • in stats::power.t.test: “number of observations (per group)”

I've also deleted the entry for the comp column—it's not an output column for any broom methods currently and did not result from a PR re: other tidier methods.

simonpcouch added a commit to tidymodels/broom that referenced this pull request May 22, 2020
@simonpcouch
add svd return value alexpghayes/modeltests#26, document()
3d4739d
@simonpcouch simonpcouch marked this pull request as draft May 22, 2020 20:39
@simonpcouch
Copy link
Collaborator Author

...One more round of adding on to this PR! I added to the broom documentation helper checks to check that each argument to return_*() functions resulted in an entry in the broom documentation. The output that I was working with for this last commit is in tidymodels/broom#856.

There are also some formatting edits to the yml as well.🙂

@simonpcouch simonpcouch changed the title add p.values arg for tidymodels/broom#833 edits to argument and column glossaries May 22, 2020
@simonpcouch simonpcouch marked this pull request as ready for review May 22, 2020 22:00
@simonpcouch simonpcouch mentioned this pull request May 27, 2020
Merged
@alexpghayes alexpghayes merged commit 3f78cac into alexpghayes:master May 28, 2020
clrpackages pushed a commit to clearlinux-pkgs/R-broom that referenced this pull request Jul 14, 2020
@fenrus75
R-broom: Autospec creation for update from version 0.5.6 to version 0…
1f4aafe 
….7.0

Grant McDermott (24):
      Add logitmfx tidiers
      Better regexp
      Add more examples
      Add probit tidiers (same as logit TBH)
      Updated NAMESPACE after adding new mfx tidiers
      Correct function name would be nice
      Just use logitmfx tidiers for probitmfx equivalents
      Catch cases where user doesn't specify atmean argument
      Add tests for mfxlogit
      Argh, correct function name again
      Better name
      Add probitmfx tests
      Squash into generic tidiers with various methods
      Missed on previous commit
      Right export names would help...
      Add contributor details
      Suggest packages
      Fix mfx rdnames and methods
      Retain SEs of input object
      mfx tidiers to NEWS.md
      Resolve Alex's PR commments
      Separate out betamfx tidiers
      Drop deprecated fix_data_frame function
      Update NAMESPACE

Greg Macfarlane (6):
      Write tidy method for sarlm models
      Add glance and augment for sarlm objects; document
      Simplify logic of spatial regression tidying
      Write tidy method for sarlm models
      Add glance and augment for sarlm objects; document
      Simplify logic of spatial regression tidying

Lukas Wallrich (3):
      Add option to return p.values to tidy.polr
      Update NEWS.md
      Update DESCRIPTION

Max Kuhn (1):
      0.7.0 revdeps

Petr Hrobar (2):
      model added
      model added

Simon Couch (61):
      restore .Rproj... oops🙈
      add svd return value alexpghayes/modeltests#26, document()
      check when entries don't result in docs
      work through failing return_* entries (closes #856)
      small build fixes
      fix `codecov` and `pkgdown` actions
      use lavaan extractors in glance.lavaan (#835)
      explicitly coerce to tibble (closes #824)
      tidyverse -> tidymodels in links (closes #832)
      pass ddf arg to confint (#839)
      adjust covr install re: 4.0.0 error
      update gh actions R version
      install tidytemplate for pkgdown
      correct nobs and norig in glance.lavaan (closes #835)
      note deprecation of fix_data_frame() (#806, #862)
      restore n column re: chest revdepcheck (#862)
      refresh docs with devel modeltests version
      restore .resid column to augment.nls output
      restore sparse matrix tidiers (closes #470)
      small build fixes
      use_tidy_style() (closes #640)
      document after use_tidy_style()
      last few fixes to evalRd return_*() calls
      deprecate fix_data_frame() (closes #629, closes #806)
      add contributors🙂
      glance.lm edge cases (closes #865)
      add helper for tidy methods
      small build fixes
      use modeltests for car:: unit tests
      unname columns generated from predict() (closes #866)
      for now, use devel modeltests for unit testing
      wait on modeltests release for car::Anova tests
      wait for modeltests release to check arguments
      document p.values arguments
      correct language about glance.aov changes (closes #864)
      warn on tidy_optim standard error (closes #529)
      deprecate summary.manova()
      address TODOs in NEWS.md
      spellcheck
      update to new tidyr::(un)nest() API (#831, closes #870)
      more vignette edits (closes #831)
      windows 3.6 build fix
      only manually install mnormt on windows
      windows 3.6 build failing re: new mnormt release
      add glance helper (#823)
      run document()
      refactor glance() methods (closes #823)
      a few more NEWS.md updates for 0.7.0
      rename helpers for internal consistency
      ensure no docs for map_as_tidy_tibble
      small vignette style edits (closes #831)
      restore unit tests re: modeltests v0.1.2 (closes #869)
      update fixest tidiers with new internal helpers and documentation
      document tidy.map return value (closes #481)
      small build fixes
      remove duplicate entry
      workshop NEWS.md
      fix merge conflict
      fix url formatting
      replace `iris` with `trees`, fix badges
      formatting/spellcheck

Simon P. Couch (54):
      resolve merge conflicts, use helpers in #847 tidiers
      recover original response name, clarify docs (#847)
      spellcheck/clarify automated docs
      add `spatialreg` contributions (#847)
      build fixes
      add unit testing for #847
      build fixes
      more build fixes
      correct documentation
      skip sarlm examples
      skip redundant examples
      improve errors for scam objects (closes #186)
      use conf.int idiom (closes #868)
      address package lint
      increment version number
      documentation updates re: lint
      update cran comments
      clean up pkgdown yaml
      add myself as author per alex's request
      submit to CRAN!
      fixes from CRAN pretest failure - new `fixest` version
      update timeline
      submit round 2!
      link to man files rather than topics (r-lib/roxygen2#1109)
      cran submission 3
      adjust docs for reexports
      specify base and stats namespaces
      explicitly export mfx aliased functions (#873)
      fix for internal .Rd linking
      more internal .Rd fixes
      link to quantreg file rather than topic
      note docs changes, update title
      clarify news re: new tidiers
      submission
      submit to CRAN
      update epi.2by2 tests
      submit to cran
      bump version
      write out iris in favor of modeldata::hpc_data
      update docs with reexports and iris -> hpc_data change
      bump version back
      soften deprecations
      adjust language about deprecations
      some check fixes re: deprecations
      tidy.dist fixes
      /dontrun examples with longest runtime
      update cran comments with new revdepchecks records
      restore finish_glance
      add deprecation notice to finish_glance
      more notes on reverse dependency checks
      submit to cran
      skip most unit tests on CRAN
      submit to cran
      accepted to CRAN🎉

karldw (10):
      Auto-remove trailing whitespace
      Start adding fixest
      Progress on fixest tidiers
      Progress on fixest tidiers
      Fixes to fixest tidiers
      Fix roxygen issues
      Address fixest PR comments
      Address additional fixest comments
      Bump required fixest version
      Remove deprecated `fix_data_frame`

petrhrobar (2):
      Another model support added (line 31)
      Another model support added (line 31)

topepo (1):
      revdeps on 05-26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@simonpcouch @alexpghayes