diff options
| author | Johannes Ranke <jranke@uni-bremen.de> | 2021-02-04 11:24:22 +0100 |
|---|---|---|
| committer | Johannes Ranke <jranke@uni-bremen.de> | 2021-02-04 11:41:06 +0100 |
| commit | ac183c732317cf6ede26a2ee127604a407f0a6b3 (patch) | |
| tree | 2283709a2e01206af576a9cf324f54fbfab972d0 /docs/reference/mmkin.html | |
| parent | 83798cce97e73ec3bfd11b8cb4e2929e5089aaeb (diff) | |
Documentation improvements, mainly fixing example code
The errors in the example code were in the \dontrun sections, so they
were not caught by CRAN checks. In addition, the static help files
generated with pkgdown were cached, so I noticed the errors only
after completely regenerating the documentation for version 1.0.0.
Diffstat (limited to 'docs/reference/mmkin.html')
| -rw-r--r-- | docs/reference/mmkin.html | 15 |
1 files changed, 11 insertions, 4 deletions
diff --git a/docs/reference/mmkin.html b/docs/reference/mmkin.html index 20134030..77f815da 100644 --- a/docs/reference/mmkin.html +++ b/docs/reference/mmkin.html @@ -158,7 +158,10 @@ datasets specified in its first two arguments.</p> cores <span class='op'>=</span> <span class='fu'>parallel</span><span class='fu'>::</span><span class='fu'><a href='https://rdrr.io/r/parallel/detectCores.html'>detectCores</a></span><span class='op'>(</span><span class='op'>)</span>, cluster <span class='op'>=</span> <span class='cn'>NULL</span>, <span class='va'>...</span> -<span class='op'>)</span></pre> +<span class='op'>)</span> + +<span class='co'># S3 method for mmkin</span> +<span class='fu'><a href='https://rdrr.io/r/base/print.html'>print</a></span><span class='op'>(</span><span class='va'>x</span>, <span class='va'>...</span><span class='op'>)</span></pre> <h2 class="hasAnchor" id="arguments"><a class="anchor" href="#arguments"></a>Arguments</h2> <table class="ref-arguments"> @@ -189,7 +192,11 @@ for parallel execution.</p></td> </tr> <tr> <th>...</th> - <td><p>Further arguments that will be passed to <code><a href='mkinfit.html'>mkinfit</a></code>.</p></td> + <td><p>Not used.</p></td> + </tr> + <tr> + <th>x</th> + <td><p>An mmkin object.</p></td> </tr> </table> @@ -227,9 +234,9 @@ plotting.</p></div> <span class='va'>time_default</span> </div><div class='output co'>#> user system elapsed -#> 4.869 0.357 1.415 </div><div class='input'><span class='va'>time_1</span> +#> 4.634 0.317 1.280 </div><div class='input'><span class='va'>time_1</span> </div><div class='output co'>#> user system elapsed -#> 5.502 0.002 5.507 </div><div class='input'> +#> 5.249 0.016 5.267 </div><div class='input'> <span class='fu'><a href='endpoints.html'>endpoints</a></span><span class='op'>(</span><span class='va'>fits.0</span><span class='op'>[[</span><span class='st'>"SFO_lin"</span>, <span class='fl'>2</span><span class='op'>]</span><span class='op'>]</span><span class='op'>)</span> </div><div class='output co'>#> $ff #> parent_M1 parent_sink M1_M2 M1_sink |