Commit 751f620b authored by julien veyssier's avatar julien veyssier
Browse files

update README

parent 420f7796
......@@ -67,13 +67,21 @@ The "-c" Bash script option allows you to directly give a list of packages to ch
This is the simple way to use the R package checker. The script prints current steps in stdout and all R output files in the output directory (-d|--dest DESTINATION_DIRECTORY).
This tool was initially designed to take a package name as the main parameter and check everything that depends on it. This can be done with the -p parameter.
You can also give a list of packages to test (--checklist to give a list with versions and --checklistraw to give a simple list, last versions available are processed).
Another way to use R-package-checker is to pass a folder which contains packages tarballs with -t option. These packages are installed and checked.
Here are the script options :
```
rtest.sh [-p|--package NAME_OF_PACKAGE_TO_TEST || -c|--checklist CHECKLIST_FILE] [-l|--libuser R_USER_LIB_VALUE] [-d|--dest DESTINATION_DIRECTORY] [-m|--mail MAIL_TO] [-u|--urlresult URL] [-r|--repo PACKAGE_TO_TEST_REPO] [-x|--xvfb XVFB-RUN PATH] [-n|--nbcores NBCORES] [-s|--skipinstall] [-h|--html]
rtest.sh [-p|--package NAME_OF_PACKAGE_TO_TEST || -c|--checklist CHECKLIST_FILE || --checklistraw -t|--tarfolder TAR_FOLDER_PATH] [-l|--libuser R_USER_LIB_VALUE] [-d|--dest DESTINATION_DIRECTORY] [-m|--mail MAIL_TO] [-u|--urlresult URL] [-r|--repo PACKAGE_TO_TEST_REPO] [-x|--xvfb XVFB-RUN PATH] [-n|--nbcores NBCORES] [-s|--skipinstall] [-h|--html] [--rpath PATH_TO_R_BINARY]
-p | --package NAME_OF_PACKAGE_TO_TEST : name of package to test (case sensible), all packages depending on this package are going to be checked by their R CMD CHECK
-c | --checklist CHECKLIST_FILE : file listing packages you want to check (each line should look like : PKG_NAME,PKG_VERSION,anything)
--checklistraw RAW_CHECKLIST_FILE : file listing packages you want to check (simply one package name per line)
-t | --tarfolder TAR_FOLDER_PATH : path to folder where tarballs of packages can be found. All of these packages are going to be \"R CMD CHECKED\"
-r | --repo PACKAGE_TO_TEST_REPO : repository of package you want to test (DEFAULT : R-CRAN)
-l | --libuser R_LIBS_USER : directory where packages depending on PACKAGE_TO_TEST are going to be installed (DEFAULT : R will choose it)
This directory can be used several times for several tests. Using same directory several times will save time.
......@@ -99,6 +107,8 @@ Using the --html option, each step triggers the update of an html page located i
## With the basic web interface
The basic web interface launches rtest.sh with -p option to test all packages depending on a specific one.
To setup and use the web interface you need to :
* Copy view.php, start.php, config.php in a directory inside your web root
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment