Learn R Programming

inlinedocs (version 2019.12.5)

Convert Inline Comments to Documentation

Description

Generates Rd files from R source code with comments. The main features of the default syntax are that (1) docs are defined in comments near the relevant code, (2) function argument names are not repeated in comments, and (3) examples are defined in R code, not comments. It is also easy to define a new syntax.

Copy Link

Version

Install

install.packages('inlinedocs')

Monthly Downloads

1,387

Version

2019.12.5

License

GPL-2 | GPL-3

Issues

Pull Requests

Stars

Forks

Repository

http://github.com/tdhock/inlinedocs

Maintainer

Last Published

December 5th, 2019

Functions in inlinedocs (2019.12.5)

leadingS3generic

check whether function name is an S3 generic

get_internal_S3_generics

get internal S3 generics

extra.code.docs

Extract documentation from code chunks

combine.character

combine character

inlinedocs-package

Convert inline comments to documentation

do.not.generate

do not generate

save.test.result

save test result

fake_package_env

fake package env

extract.docs.file

extract docs file

kill.prefix.whitespace

kill prefix whitespace

extract.xxx.chunks

Extract documentation from a function

extract.file.parse

File content analysis

is_primitive_in_base

is primitive in base

extract.docs.setClass

S4 class inline documentation

fixPackageFileNames

fixPackageFileNames

get_S3_primitive_generics

get S3 primitive generics

non.descfile.names

non descfile names

package.skeleton.dx

Package skeleton deluxe

getKnownS3generics

getKnownS3generics

make.package.and.check

make package and check

nondesc.parsers

nondesc parsers

removeAliasesfrom.Rd.file

removeAliasesfrom Rd file

classic.parsers

classic parsers

default.parsers

default parsers

Link documentation among related functions