Sign Up

Sign Up to our social questions and Answers Engine to ask questions, answer people’s questions, and connect with other people.

Have an account? Sign In

Have an account? Sign In Now

Sign In

Login to our social questions & Answers Engine to ask questions answer people’s questions & connect with other people.

Sign Up Here

Forgot Password?

Don't have account, Sign Up Here

Forgot Password

Lost your password? Please enter your email address. You will receive a link and will create a new password via email.

Have an account? Sign In Now

You must login to ask a question.

Forgot Password?

Need An Account, Sign Up Here

Please briefly explain why you feel this question should be reported.

Please briefly explain why you feel this answer should be reported.

Please briefly explain why you feel this user should be reported.

Sign InSign Up

The Archive Base

The Archive Base Logo The Archive Base Logo

The Archive Base Navigation

  • Home
  • SEARCH
  • About Us
  • Blog
  • Contact Us
Search
Ask A Question

Mobile menu

Close
Ask a Question
  • Home
  • Add group
  • Groups page
  • Feed
  • User Profile
  • Communities
  • Questions
    • New Questions
    • Trending Questions
    • Must read Questions
    • Hot Questions
  • Polls
  • Tags
  • Badges
  • Buy Points
  • Users
  • Help
  • Buy Theme
  • SEARCH
Home/ Questions/Q 7904795
In Process

The Archive Base Latest Questions

Editorial Team
  • 0
Editorial Team
Asked: June 3, 20262026-06-03T10:14:37+00:00 2026-06-03T10:14:37+00:00

When documenting R functions in a myfunction.Rd and whole packages in a mypackage-package.Rd ,

  • 0

When documenting R functions in a myfunction.Rd and whole packages
in a mypackage-package.Rd, which tags are compulsory?

By “tags”, I mean those things that look like \somename{}. For example:
\item{}
\title{}
\examples{}

  • 1 1 Answer
  • 0 Views
  • 0 Followers
  • 0
Share
  • Facebook
  • Report

Leave an answer
Cancel reply

You must login to add an answer.

Forgot Password?

Need An Account, Sign Up Here

1 Answer

  • Voted
  • Oldest
  • Recent
  • Random
  1. Editorial Team
    Editorial Team
    2026-06-03T10:14:38+00:00Added an answer on June 3, 2026 at 10:14 am

    This is described in Section 2.1 – Rd format of Writing R Extensions. Look for “mandatory”.

    For functions, the mandatory sections are:

    \name{name}
    \alias{topic}
    \title{title}
    \description{...}
    \usage{fun (arg1, arg2, ...)}
    \arguments{...}
    

    For packages:

    \name{name}
    \alias{topic}
    \title{title}
    \docType{package}
    
    • 0
    • Reply
    • Share
      Share
      • Share on Facebook
      • Share on Twitter
      • Share on LinkedIn
      • Share on WhatsApp
      • Report

Sidebar

Related Questions

I'm in the process of documenting some of my functions for an R package
Is there a syntax for documenting functions which take a single configuration array, rather
I've been documenting a software package using Sphinx and reStructuredText . Within my documents,
Is there a best practice way of documenting which outside constants are used by
so I decided I would put my few R functions into a package and
I'm wondering if there is a tool for documenting the java application. I mean
Is there something like javadoc or rdoc for documenting YAML files, so that we
Using Doxygen 1.7.4 Sometimes I'll have a block of public member functions that belong
I was given the task of documenting an application that has no comments. However,
Related: Correct way to document open-ended argument functions in JSDoc I've a function that

Explore

  • Home
  • Add group
  • Groups page
  • Communities
  • Questions
    • New Questions
    • Trending Questions
    • Must read Questions
    • Hot Questions
  • Polls
  • Tags
  • Badges
  • Users
  • Help
  • SEARCH

Footer

© 2021 The Archive Base. All Rights Reserved
With Love by The Archive Base

Insert/edit link

Enter the destination URL

Or link to existing content

    No search term specified. Showing recent items. Search or use up and down arrow keys to select an item.