[R] [FORGED] Re: pair correlation function of 3D points

Abby Spurdle @purd|e@@ @end|ng |rom gm@||@com
Wed Apr 29 07:31:14 CEST 2020

I should have noted that my comments weren't directed towards the main
authors, but to all people listed in the description file, which is
many, including some R core members.

Also, overall, I'm impressed by the effort here. It's just I strongly
feel that good documentation is crucial (especially in open source),
and I was somewhat disappointed that, given how many people are/were
involved in this package, not one (after approx 24 hours) had tried to
help answer the OP's question.

> > *If* it does what it claims ...
> Why would you doubt that it does what it claims?

Because I didn't test it.

> Wouldn't the first thing that one would try be:
>    ??"pp3"

No, because I was reading the PDF version of the documentation.

> Of course I'm biased, but IMHO spatstat is documented not only
> "properly", but superbly well! :-)

I started reading the pcf function first.
This function has the same problem, it doesn't clearly describe the
function arguments.
It doesn't say whether it applies to 2d, 3d or higher-dimensional data.
After reading it, I had no idea whether the function could be applied
to 3d data or not.

In my opinion this is not sufficient.
Descriptions of function arguments and return values should be clear.

But here's a bigger problem.
The documentation says the pcf function is a generic, but the pcf3est
function isn't a method.
And the pcf documentation (along with the three methods) don't
reference the pcf3est function.

I found the pcf function via Googling the subject.
But unless someone goes through a list of all the help topics, they're
unlikely to find the pcf3est function.

More information about the R-help mailing list