selsfm.Rd: a model table up front, per-model arguments and values (issue #3) - #48
Merged
Merged
Conversation
…sue #3) The page described only the Greene model's return value and arguments; for "kts" it did not say that Nsim, sim_type, antithetics and seed are unused, that a numeric start_val is used as the start (scales as logs), that $objective is always returned, or what parameters and counts the fit carries. The KTS discussion moves into Details beside Greene's, under titled subsections. \usage is unchanged. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_014oJL17ewiahA8pWbemnqNp
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This continues the issue #3 readability pass with
selsfm.Rd. It covers two models,"greene"and"kts", but most of the arguments and the whole of \value described"greene"only. Every fact below was checked againstR/selsfm.R,R/selsfm_kts.Rand fits on main.Corrected or added facts
Nsim,sim_type,antithetics,seed: no mention of model"kts"never receives them (.selsfm_kts_fit()has no such parameters).selsfm_kts_fitstart_val: "Name the starting-value vector""greene". For"kts", a numericstart_valis used as the start, with the four scales as logsselsfm_kts.R:if (is.numeric(start_val)) start_v <- start_val; the start vector holdslog(...)scaleskeep_objective:FALSEby default"kts"ignores it and always returns$objective!is.null(f$objective)isTRUEsigma_u, sigma_v, rho, coefficients"greene"only."kts"returnst0.*,t1.*,sigma_v0,sigma_v1,sigma_u0,sigma_u1,choice.*,deltarownames(f$out)on akts_sim(600, 3)fitnobs,n_selected"greene":nobs= selected rows (437 of 800 in the example)."kts":nobs= every row used (600),n_selected= technology-1 rows (368 = Σ I)selection: response may be logical or a two-level factor"greene"only."kts"requires 0/1"kts"branch's binary checkfrontier:ymay beNAwhered == 0"greene"only."kts"drops any incomplete rowcomplete.cases()in.selsfm_kts_fitLayout
model_name, model, and what drives the choice.\section{The KTS model}moved into the second one unchanged, recovery table included.No technical content was removed.
\usageis byte-identical, andtools::checkRd()is clean. I checked the rendered text withR CMD Rdconv -t txt; table cells are kept on one line so the columns don't run together.🤖 Generated with Claude Code
https://claude.ai/code/session_014oJL17ewiahA8pWbemnqNp
Generated by Claude Code