Repository files navigation

Seethis link for an important summary of my AI/FROC research websites.

• See here for update history details.
• CurrentGitHub version is 2.1.2.9000 on themaster branch.
• CurrentCRAN version is 2.1.2.

• The most current tested version of the software and documentation is on themaster branch.
• Thedeveloper branch is for development/experimental work.

Three options are given below in increasing order of complexity.+ The first method downloads the package from CRAN.+ The second downloads the package from themaster branch onGitHub.+ The third downloads all source files from themaster branch onGitHub and then installs the software. I recommend the second method as the CRAN package is behind themaster branch.

• InstallR andRStudio.
• Create an empty directory, e.g.,myProject. In my computer it is/Users/Dev/Downloads/myProject.
• OpenRStudio by clicking on themyProject.Rproj file.
• Starting fromRStudio >Packages >Install >RJafroc.
• library(RJafroc).
• This loads the CRAN package and all functions on thecran2 branch become available.
• For documentation of functions and vignettes,see. It may be helpful to have both windows open (RStudio and the above website) simultaneously.
• The CRAN version will not include more recent updates on themaster branch. To access them use the next suggested method, below.
• Test the installation:

cbmPlot <- PlotCbmFit(c(1, 2), c(0.5, 0.5))print(cbmPlot)

• You should see two ROC plots in thePlots window.

• InstallR andRStudio.
• Create an empty directory, e.g.,myProject. In my computer it is/Users/Dev/Downloads/myProject.
• OpenRStudio by clicking on themyProject.Rproj file.
• Starting fromRStudio >File >New Project >Existing Directory > SelectmyProject >Create Project.
• Oila! You should seemyProject.RProj in the Files menu.
• Install thedevtools package as shown below:
• Starting fromRStudio >Packages >Install >devtools.
• Loaddevtools as shown below:

library(devtools)

• InstallRJafroc directly fromGitHub (this is wheredevtools is used):

install_github("dpc10ster/RJafroc")

• Hit Enter on any prompts...
• Lots of activity and compilation of C++ code ....
• LoadRJafroc as shown below:

library(RJafroc)

• Test the installation:

cbmPlot <- PlotCbmFit(c(1, 2), c(0.5, 0.5))print(cbmPlot)

• You should see two ROC plots in thePlots window.
• Documentation (vignettes) isavailable.
• Be sure to study these examples and make full use of the online documentation.
• Put your data and other files, if any, inmyProject.

• Clone this repository to a directory anywhere on your computer. On my computer it is in/Users/Dev/Downloads/RJafroc. Rename the folder if necessary to match my example.
• I find the GitHub desktop app useful in mananging my downloads/uploads fromGit.
• InstallR andRStudio.
• Navigate to theRJafroc directory.
• OpenRJafroc.Rproj. This will openRStudio.
• Navigate toFile menu (lower-right window) and click on DESCRIPTION file.
• Install all packages listed under Imports, e.g.,
  openxlsx,ggplot2,stringr,tools,utils,stats,bbmle,binom,mvtnorm,dplyr,numDeriv,Rcpp
• For example, to install the first two above-listed packages, use the following command at the Console prompt:

install.packages(c("openxlsx", "ggplot2"))

• Click on Build > Install and Restart (upper right panel). If errors result from missing packages, install those packages.
• A successful Install and Restart will result in the following line in the Console window:

library(RJafroc)

• Thats it!RJafroc has been installed to your computer and is visible to any otherR project in any directory.
• You will not need to access theRJafroc folder again (unless you reinstall a new version of the software).
• Do not write any of your files to theRJafroc directory!
• All necessary files of the installation are in a hidden directory that you do not normally need to worry about.
• Create an empty directory, e.g.,myProject, outside of theRJafroc folder. In my computer it is/Users/Dev/Downloads/myProject.
• Starting fromRStudio >File >New Project >Existing Directory >myProject >Create Project.
• Oila! You should seemyProject.RProj in the Files menu.
• Click onPackages and scroll down to findRJafroc, and check the box next to it. This results inRJafroc being loaded to the current workspace. The following line appears in the Console window (this is the hidden directory referrred to above).

  library("RJafroc", lib.loc="/Library/Frameworks/R.framework/Versions/3.5/Resources/library")

• Click onRJafroc in the packages window. A help window opens up. I find it convenient to put this in its own window by clicking the "out" arrow button (hover message: Show in new window). You can access all documentation from here.
• Test the installation:

cbmPlot <- PlotCbmFit(c(1, 2), c(0.5, 0.5))print(cbmPlot)

• You should see two ROC plots in thePlots window.
• Preliminary documentation (vignettes) isavailable.
• Put your data and other files, if any, in myProject.
• TBA

• As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.

• We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.

• Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.

• Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.

• Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.

dpc10ster@gmail.com