ddf() documentation says mono.strict when TRUE (default when mono=TRUE) but default is actually FALSE

[jjrob]

The help for ddf() says:

mono.strict when TRUE (default when mono=TRUE) strict monotonicity is enforced, else only weak monotonicity

But in ddf.ds.R there is:

  # Set up meta data values
  meta.data <- assign.default.values(meta.data, left=0, width=NA, binned=FALSE,
                                    int.range=NA, mono=FALSE, mono.strict=FALSE,
                                    point=FALSE)

The default for mono.strict is FALSE under all circumstances. The documentation suggests that mono.strict will be TRUE when mono is TRUE, unless you explicitly specify mono.strict=FALSE.

Please adjust the code and documentation to be consistent with each other.

[lenthomas]

I think we'd like the default for mono.strict to be TRUE (since this is what mcds.exe does); I guess mono.strict is ignored when mono=FALSE, and the documentation should make this clear. So:

no monotonicity -- mono=FALSE mono.strict is ignored weak monotonicity -- mono=TRUE mono.strict=FALSE strong monotonicity -- mono=TRUE mono.strict=TRUE

OK? Len

On 12/05/2017 13:18, Jason J Roberts wrote:

The help for ddf() says:

mono.strict
when TRUE (default when mono=TRUE) strict monotonicity is enforced,
else only weak monotonicity

But in ddf.ds.R there is:

Set up meta data values

meta.data <- assign.default.values(meta.data, left=0, width=NA, binned=FALSE, int.range=NA, mono=FALSE, mono.strict=FALSE, point=FALSE)

The default for |mono.strict| is |FALSE| under all circumstances. The documentation suggests that |mono.strict| will be |TRUE| when mono is |TRUE|, unless you explicitly specify |mono.strict=FALSE|.

Please adjust the code and documentation to be consistent with each other.

— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub https://github.com/DistanceDevelopment/mrds/issues/17, or mute the thread https://github.com/notifications/unsubscribe-auth/AAH57zpx8PAG3MpYSdC7VVoBDSsICNqJks5r5E4bgaJpZM4NZNnR.Web Bug from https://github.com/notifications/beacon/AAH57-zNz6Vl9ezDlO1h3x5FEfRvb8QMks5r5E4bgaJpZM4NZNnR.gif

{"api_version":"1.0","publisher":{"api_key":"05dde50f1d1a384dd78767c55493e4bb","name":"GitHub"},"entity":{"external_key":"github/DistanceDevelopment/mrds","title":"DistanceDevelopment/mrds","subtitle":"GitHub repository","main_image_url":"https://cloud.githubusercontent.com/assets/143418/17495839/a5054eac-5d88-11e6-95fc-7290892c7bb5.png","avatar_image_url":"https://cloud.githubusercontent.com/assets/143418/15842166/7c72db34-2c0b-11e6-9aed-b52498112777.png","action":{"name":"Open in GitHub","url":"https://github.com/DistanceDevelopment/mrds"}},"updates":{"snippets":[{"icon":"DESCRIPTION","message":"ddf() documentation says mono.strict when TRUE (default when mono=TRUE) but default is actually FALSE (#17)"}],"action":{"name":"View Issue","url":"https://github.com/DistanceDevelopment/mrds/issues/17"}}}

-- Len Thomas len.thomas@st-andrews.ac.uk lenthomas.org @len_thom Centre for Research into Ecological and Environmental Modelling The Observatory, University of St Andrews, Scotland KY16 9LZ Landline: UK+1334-461801 Admin: UK+1334-461842

The University of St Andrews is a charity registered in Scotland, No SC013532.

---

This email has been checked for viruses by Avast antivirus software. https://www.avast.com/antivirus

[jjrob]

To clarify what I am requesting:

From the documentation it appeared that merely passing mono=TRUE was sufficient to obtain strong monotonicity. In fact, merely passing mono=TRUE obtains weak monotonicity. To obtain strict monotonicity, it is currently necessary to pass mono=TRUE, mono.strict=TRUE.

If the current behavior is the correct behavior, the text "(default when mono=TRUE)" should be removed from the documentation.

If that text is left in the documentation, the behavior should be changed so that if the caller passes mono=TRUE that mono.strict defaults to TRUE rather than FALSE.