checkNamespace: Check Namespace and Rd files

Description Usage Arguments Details Value Author(s) See Also Examples

View source: R/system_and_package.R

Description

Check Namespace/Rd and examples files.

Usage

1
2
3
4
5
6
checkNamespace(path.namespace,path.rfolder)
checkAliases(path.man,path.rfolder)
checkTF(path.man)
checkExamples(path.man,each = 1,print.errors = stderr(),
	print.names = FALSE)
checkUsage(path.man,path.rfolder)

Arguments

path.namespace

An full path to the "NAMESPACE" file.

path.rfolder

An full path to the directory that contains the "R" files.

path.man

An full path to the directory that contains the "Rd" files.

each

An integer value for running each example.

print.errors

Print the errors to a file. By default it's "stderr()".

print.names

A boolean value (TRUE/FALSE) for printing the names of the files before running the examples.

Details

For function "checkNamespace": reads from the NAMESPACE folder all the export R functions, reads from folder R all the R functions and check if all the functions are export.

For function "checkAliases": reads from the man directory all the Rd files, then reads from each file the aliases and check if: 1) All the R files has man file or an alias. 2) All aliases belongs to functions. 3) If there are dublicated aliases.

For function "checkExamples": reads from the man directory all the Rd files, then read from each file the examples and then run each of them. If you want to print the errors in any file then set "print.errors=file_name" or in the standard error "print.errors=stderr()" and then you will see all the errors for every file. For succeed run of your code you should first run "library(PACKAGE_NAME)". The argument "print.names" it is very helpful because if any of you function crashes R during running you will never know which one was. So setting it "TRUE", it will print the name of each file before runnign it's example.It might crash, but you will know which file. Remember that there is always an error timeout so it might didn't crash the current file but one from the previous.

For function checkTF: reads from the man directory all the Rd files, then read from each file the examples and checks if any examples has the values "T" and "F" instead "TRUE" and "FALSE". The "T","F" is wrong.

For function checkUsage: reads from the man directory all the Rd files and for each man check if the usage section has the right signature for the functions from the R directory.

For functions "checkTF", "checkUsage", "checkAliases" you can choose which files not to read for both R and Rd. You must add in the first line of the file in comment the "attribute" "[dont read]". Then each function will now which file to read or not. For Rd you add "%[dont read]" and for R "#[dont read]". Finally, these functions will return in the result a list of which files had this attribute.

Value

For function "checkNamespace": a vector with the names of missing R files. (Don't use it for now)

For function "checkAliases": a list with 4 fields.

Missing Man files

A vector with the names of the missing Rd files.

Missing R files

A vector with the names of the missing R files.

Duplicate alias

A vector with the names of the dublicate aliases.

dont read

A list with 2 fields R: A character vector whith the names of the files that had attribute "#[dont read]" Rd: A character vector whith the names of the files that had attribute "%[dont read]"

For function "checkExamples": a list with 3 fields

Errors

A character vector with the names of the Rd files that produced an error.

Big Examples

A character vector with the names of the Rd files that has big examples per line.

dont read

A list with 2 fields R: A character vector whith the names of the files that had attribute "#[dont read]" Rd: A character vector whith the names of the files that had attribute "%[dont read]"

For function "checkTF": a list with 3 fields

TRUE

A character vector with the names of the Rd files that has "T".

FALSE

A character vector with the names of the Rd files that has "F".

dont read

A list with 2 fields R: A character vector whith the names of the files that had attribute "#[dont read]" Rd: A character vector whith the names of the files that had attribute "%[dont read]"

For function "checkUsage": a list with 3 fields

missing functions

A character vector with the name of the file that is missing and the Rd file that is found.

missmatch functions

A character vector with the name of the file that has missmatch function and the Rd file that is found.

dont read

A list with 2 fields R: A character vector whith the names of the files that had attribute "#[dont read]" Rd: A character vector whith the names of the files that had attribute "%[dont read]"

Author(s)

R implementation and documentation: Manos Papadakis <papadakm95@gmail.com>.

See Also

read.directory, AddToNamespace, sourceR, sourceRd, read.examples

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
## Not run: 
 for example: path.namespace="C:\some_file\NAMESPACE"
 for example: path.rfolder="C:\some_file\R\"
 for example: path.man="C:\some_file\man\"
 system.time( a<-checkNamespace(path.namespace,path.rfolder) )
 system.time( b<-checkAliases(path.man,path.rfolder) )
 system.time( b<-checkExamples(path.man) )
 system.time( b<-checkExamples(path.man,2) )
 system.time( b<-checkTF(path.man) )
 system.time( b<-checkTF(path.man,path.rfolder) )

## End(Not run)

Rfast documentation built on May 18, 2021, 1:07 a.m.