Earth Sciences

Earth Sciences Wiki

User Tools

Site Tools


tools:diagnostics

outdated

The information on this page is badly out-of-date. It describes a system that is no longer in production or has drastically changed, Please see s2dverification

Description of the set of R functions

As a new user, please register to this mailing list: http://commondiags.ic3.cat/mailman/listinfo/commondiags You'll then have access to the history of all the emails sent to the users and presenting the functions and their available options.

To use the R common diagnostic functions, open a R session and type: source('~/CFU_tools/diagnostics/common_diagnostics.txt')

The list of available functions will be printed. For more information about any function, type info_cd('function name'), you'll see a quick description of the aim of this function, the input arguments, the output variables and the contact in case of questions. Please, feel free to update the help if the explanations are not clear, and to add any option you feel helpful for the other users

For a quick overview of the functionalities available, please have a look at this presentation : cfu_r_common_diagnostics.ppt

For an example about the use of the R common diagnostics, you can try plot_timeseries.R

Style guide

For practices that ensure a long-term sustainable development look at this presentation: longtermdev.pdf

The style guidelines that we will apply to develop with R are from the Google's R Style Guide, with the following modifications agreed by the development team:

  • Do not use dots in variable names.
  • You can use underscores in variable names.
  • There are two levels of comments. The first, of general purpose, starts with a single hash and a space. Comments in this level should explain what the code is doing. The second, for stuff members, starts with two hashes and a space. Comments in this level should explain details not needed to understand the general procedure but useful to make note of more technical aspects that might take time to find out later.
  • A history of edition will be kept at the end of the comment that documents each function below its header. The format of the history is as follows:

# History:

 #   1.0  #  2011-03  (E. User, example.user@ic3.cat)  #  What has been done
 #        #  2013-03  (A. User, another.user@ic3.cat)  #  What has been changed    
 #        #                                            #  or added.

List of functions

Contact

virginie.guemas@ic3.cat, isabel.andreu-burillo@ic3.cat, fabian.lienert@ic3.cat, nicolau.manubens@ic3.cat

tools/diagnostics.txt · Last modified: 2015/05/26 13:25 (external edit)