Man pages for sakrejda/stannis
Handles output from Stan (mc-stan.org)

build_cmdstanBuild 'stanc' in the cmdstan directory.
build_registryBuild a registry
calculate_plist_reductionCalculate Potential Scale Reduction Factor (PSRF) or other...
calculate_reductionCalculate a per-parameter summary
check_keyCheck that a key exists in the registry
compile_modelReturn binary path to a compiled model, don't recompile if...
construct_cmdlineCreate a flat string of CmdStan arguments based on a sub-tree...
copy_failedThrow error when copying fails.
create_hashcreate a pseudo-'secret', salted with project_id
extensionRetrieve just file extension from a string
finalize_argsFinalize an argument tree object by merging components that...
findFind entry at a path in a list
find_Find entry at a path in a list
find_cmdstanFind CmdStan installation
find_fileFind a full path to a file name, recursively
find_hashPick the hash out of a path
find_modelBased on an argument tree ('args' object) find a model and...
find_run_filesFind the components of a single run under a set of paths
flatten_arrayReplace array dimensionality by explicit long-format data...
get_binary_dirreturn binary dir for this project from an argument tree...
get_cmdstanGet CmdStan from github.com/stan-dev/cmdstan
get_dimensionsRead the parameter dimensions of the binary rewrite
get_idreturn project id from an argument tree ('args' object).
get_initial_numberFind number at the head of a string.
get_parameterRead a specific parameter from the binary rewrite
get_parameter_namesGet names of parameters in set
hash_matchCheck if two hashes match.
index_hashesList all hashes under a target directory
insert_inAdd a key to a registry, with its arg-tree
install_cmdstanDownload CmdStan from github.com/stan-dev/cmdstan and build...
internal_parametersSubset a vector of names to keep only sampler/internal...
is_directoryCheck if a path exists and is a directory
is_empty_listCheck whether list elements are all zero.
is_named_data_frameCheck if input is a data frame with column names.
is_ragged_listCheck whether list elements have different lenghts.
lastTake last element of a vector.
list_maxGet the per-list-element max
list_sorted_headsGet the per-list-element sorted head
list_sorted_tailsGet the per-list-element sorted tail
load_argsLoad a Stannis run control list of arg-trees from a .yaml...
load_registryLoad a registry (or initialize if necessary).
merge_chainsMerge chains
merge_treesCombine multiple arg-trees by merging matching sub-trees.
model_parametersSubset a vector of names to keep only model parameters.
monitorMonitor runs in a given root directory
normalize_margin_namesNormalize an array's labels.
not_nullReturn an NA or the value
padded_sequenceTake a numeric sequence and force it to sort properly as a...
path_splitNormalizes a path and splits it on a path separator,...
pipere-export magrittr pipe operator
prepare_inputsPrepare a single input tree by combining paths.
print.mcmc.monitorPrint output of stannis::monitor
process_diagnosticsProcess sampling file Process diagnostics
process_key_valueProcesses a strings data format (key[split]value)
push_adaptAdd sampler adaptation sub-arguments.
push_algorithmAdd algorithm sub-arguments.
push_argBasic method to return one CmdStan argument.
push_dataAdd a data argument.
push_engineAdd HMC engine sub-arguments
push_fixedAdd fixed_param non-sampler arguments.
push_hmcAdd HMC algorithm sub-arguments
push_metricAdd HMC metric sub-arguments.
push_nutsadd nuts sampler sub-arguments.
push_outputAdd output arguments.
push_randomAdd a random init seed argument
push_sampleAdd sampler sub-arguments
push_simpleBasic method to pull out arguments by name from a list.
push_staticadd static HMC sub-arguments.
read_file_setRead a set of Stan files and their metadata
read_runRead a single Stannis run, rewrite to binary format, and...
read_stan_csvWrapper for C++ function wrapper.
register_runRecord that a run is being started
remove_failed_runsFind and remove run directories with no output file.
remove_keyRemove a record from the registry
replicate_argsReplicate arg-tree and add replicate tag.
rewrite_stan_csvRewrite a Stan .csv output file.
run_cmdstanRun a set of CmdStan runs based on a set of arg-trees in a...
run_model_cmdRun a CmdStan model based on a single arg-tree.
save_registrySave a registry
scatterScatter set
setup_runsSet up a set of file to run examples.
split_rhat_rfunrstan's split-r-hat implementation in R
std_estimatesStandard summary function.
substitutionsSubstitute tags for the referenced file content.
summarizeSummarize iterations to estimates!
tag_fileFile matching a tag. Replaces '::' separator with '-'...
tag_findFind which items of a file read in as a character vector...
tag_pullExtract the tag from file read in as a vector of text...
trim_comment_charTrims comment char from the front of a string.
trim_warmupTrim warmup
trim_whitespaceTrims whitespace from a string front and back.
uuidTurn any vector of strings into a UUID
worst_psrfGet the worst R-hat values per parameter.
sakrejda/stannis documentation built on June 25, 2022, 3:19 a.m.