siman_describe.sthlp

{smcl}
{* *! version 1.1 18dec2025}{...}
{vieweralsosee "Main siman help page" "siman"}{...}
{viewerjumpto "Syntax" "siman_describe##syntax"}{...}
{viewerjumpto "Data formats" "siman_describe##data"}{...}
{viewerjumpto "Description" "siman_describe##description"}{...}
{viewerjumpto "Authors" "siman_describe##authors"}{...}
{title:Title}

{phang}
{bf:siman describe} {hline 2} Describes the simulation data


{marker syntax}{...}
{title:Syntax}

{phang}
{cmd:siman describe} 
[{cmd:,}
{it:options}]

{pstd}The options are mainly intended for programmers.


{synoptset 25 tabbed}{...}
{synopthdr}
{synoptline}
{synopt:{opt ch:ars}}lists the characteristics created by {bf:{help siman setup}} and explained {bf:{help siman setup##chars:here}}.{p_end}
{* {synopt:{opt s:ort}}is used with {opt chars}: it sorts the characteristics alphabetically before listing.{p_end}}{...}
{* {synopt:{opt sav:ing(filename)}}is used with {opt chars}: it saves the characteristics to the file specified.{p_end}}{...}
{synoptline}


{marker description}{...}
{title:Description}
{pstd}

{pstd}
{cmd:siman describe} provides a summary of the data previously imported by {help siman setup}, 
and whether estimates data and performance estimates are in the dataset. Of course, {help siman setup} needs to be run before {bf:siman describe} can be used.


{marker authors}{...}
{title:Authors}

{pstd}See {help siman##updates:main help page for siman}.


{title:See Also}

{p}{helpb siman: Return to main help page for siman}