[R] Request for help

[Duncan Murdoch]

On 03/06/2016 2:27 PM, Bert Gunter wrote:
> See the "Writing R Extensions" manual that ships with R.
>
> You might also want to consider Hadley Wickham's roxygen2 package,
> which allows one to include the Help information as specially
> formatted comments within the code files themselves. The package will
> then generate the Help files from this info automagically.

roxygen2 certainly makes writing help pages easier for the package 
author, but I don't know of any packages that use it that have adequate 
help pages from a user perspective.  I'd be interested to hear of 
counterexamples.

My advice for the original question is to use RStudio for development 
with roxygen2 support turned off, because it has nice support for 
editing .Rd files.  Use prompt() to create skeleton .Rd files for 
functions after you've written them and built the package.  Edit the 
file following the instructions contained in it, doing lots of 
previewing to make sure it looks okay.  Run checks reasonably frequently 
to find your errors and omissions.

Duncan Murdoch



> Finally, google! -- there are many other tutorials on this on the web.
>
> Cheers,
> Bert
>
>
> Bert Gunter
>
> "The trouble with having an open mind is that people keep coming along
> and sticking things into it."
> -- Opus (aka Berkeley Breathed in his "Bloom County" comic strip )
>
>
> On Fri, Jun 3, 2016 at 12:22 AM, suparna biswas <suparnabsws4 at gmail.com> wrote:
>> Dear Sir/Madam
>>                        Myself Suparna Biswas, a research scholar from the
>> department of Mathematical Sciences, Tezpur University, Assam, India. I am
>> working under the supervision of Dr. Santanu Dutta, Associate Professor,
>> Department of Mathematical Sciences, Tezpur University, Assam, India. My
>> research topic is "Estimation and Application of Risk Measure in Finance".
>>
>>                         I mainly use the R software in my research work. I
>> want to convert all my code into a R package manually. I have gone through
>> the paper by Friedrich Leisch titled "Creating R Packages: A Tutorial. But
>> I am facing problem in writing help pages. The things mentioned in the
>> paper about help pages are not clear to me as I have never written help
>> pages before.
>>
>>                         I will be obliged if you kindly help me in this
>> context. Thanking you.
>>
>> --
>> With warm regards,
>> Suparna Biswas
>> Research Scholar
>> Department of Mathematical Sciences
>> Tezpur University
>>
>>         [[alternative HTML version deleted]]
>>
>> ______________________________________________
>> R-help at r-project.org mailing list -- To UNSUBSCRIBE and more, see
>> https://stat.ethz.ch/mailman/listinfo/r-help
>> PLEASE do read the posting guide http://www.R-project.org/posting-guide.html
>> and provide commented, minimal, self-contained, reproducible code.
>
> ______________________________________________
> R-help at r-project.org mailing list -- To UNSUBSCRIBE and more, see
> https://stat.ethz.ch/mailman/listinfo/r-help
> PLEASE do read the posting guide http://www.R-project.org/posting-guide.html
> and provide commented, minimal, self-contained, reproducible code.
>