Autolinking in function documentation

[andybeet]

A nice feature of pkgdown is its autolinking. For this to work, a couple of changes need to be made to the DESCRIPTION and the _pkgdown.yml.

Once these changes are made we should be able to use syntax like \code{rsim.rum()} in our documentation and it should auto link to the function in the reference section.

This change will need to be made on master

[andybeet]

So i thought i was working on a forked version of RPath (for testing). However, I wasn't and i commited to master. I apologize. I will revert this.

EDIT: Done. I will set this up on a fork so you can see what i mean about autolinking

[andybeet]

The link should be automatic (at least it will be when we update a couple of package files) so you can drop that if you want. Not sure what happens if you leave it in, probably nothing! But if it works as you currently have it coded then that has to be ok.

I think pgkdown has added a lot of new features since we started using this package. Saying that i could not get the [] to take, like it describes in the documentation.

[biadias]

I did the same as Sarah and wrote down the \code{\link{.
I already submitted a pull request, but I can change it down the road.

[biadias]

Has someone linked functions in the vignettes? I am trying to do that but it is not linking.

Thanx

[andybeet]

From the vignette:
To link to another vignette, i used: `vignette("ModelSetup")`
To link to a function, i used: `rpath()`
This seemed to work for me

[biadias]

Thank you Andy. I figured out when I use Rpath::somefunction() it doesn't link, but if I use only the somefunction() it works perfectly fine. Thank you for your quick reply.