noamross / noamtools Goto Github PK

help_console not working for corClasses function from nlme package.

help_console(topic = corClasses, format = "latex")

Error in help_console(topic = corClasses, format = "latex") :
object 'corClasses' not found

See here http://stackoverflow.com/q/21046970/707145

Your blog post http://www.noamross.net/blog/2013/6/18/helpconsoleexample.html and thus your package noamtools were useful for this question on SO: http://stackoverflow.com/questions/20969313/r-function-help-in-tex-or-rnw-format/20972452#20972452

I tried to reference you adequately but let me know if there is anything you want added (or just edit my answer directly).

(This isn't really an issue but thought this was a somewhat appropriate place to put this message)

Tidy evaluation and NSE, especially %>% commands, can clutter up a lot of profiling views. Sometimes you want to strip this away.

An option to automatically strip out, say, internal tidyverse functions, would be useful. We could replace a run of such functions, such as everything after %>%, with a token like [tidynse], with an option like, hide_tidynse = TRUE.

One could also have an option to hide all internal package functions, or to hide internal functions of a specific list of packages.

Useful functions: ls(asNamespace("magrittr")), getNamespaceExports("magrittr").

We should be able to implement these with tidyverse packages only being Suggests, using requireNamespace(). We could even store the list of functions (memoized) internally.

This could be really useful to me, but what do you need to put in the LaTeX preamble to define the environments used in help_console. For example, in this example you'd need to define the \Author command in LaTeX.

Do you have a LaTeX template for these commands?

help_console is not capturing Authors section properly. For example help_console(topic=corClasses, format = "latex") give the following output for Author section (See here http://stackoverflow.com/q/21046970/707145):

%
\begin{Author}\relax
NA\email{[email protected]}
\end{Author}
%