extensions/net.sf.basedb.brcareg/trunk/README

Code
Comments
Other
Rev Date Author Line
1885 27 Feb 13 olle 1 == Requirements ==
1885 27 Feb 13 olle 2
1885 27 Feb 13 olle 3  1. BASE 3.2.1 or later.
1885 27 Feb 13 olle 4  
1885 27 Feb 13 olle 5 == Introduction ==
1885 27 Feb 13 olle 6
1885 27 Feb 13 olle 7 This package is an extension package to BASE that can be used to
1885 27 Feb 13 olle 8 simplify biosource and sample registration.
1885 27 Feb 13 olle 9
1885 27 Feb 13 olle 10  * The homepage for this extension: 
1885 27 Feb 13 olle 11    http://baseplugins.thep.lu.se/wiki/net.sf.basedb.brcareg
1885 27 Feb 13 olle 12
1885 27 Feb 13 olle 13 == Installation and updating ==
1885 27 Feb 13 olle 14
1885 27 Feb 13 olle 15  1. Download the brcareg-*.tar.gz file.
1885 27 Feb 13 olle 16  2. Unpack the downloaded file to a directory of your choice.
1885 27 Feb 13 olle 17  3. Copy the 'brcareg.jar' file to your BASE plug-ins directory.
1885 27 Feb 13 olle 18     Eg. the directory specified by the 'plugins.dir' setting in 'base.config'.
1885 27 Feb 13 olle 19  4. Log in to BASE as a user with Administrator priviliges. 
1885 27 Feb 13 olle 20  5. Go to 'Administrate->Plug-ins & Extensions->Overview' page.
1885 27 Feb 13 olle 21     Run the installation wizard and select to install/update 'brcareg.jar'.
1885 27 Feb 13 olle 22  6. Create a project and set it as the active project. This step is
1887 27 Feb 13 olle 23     optional but is recommended. Running BRCA-Reg without an active project
1885 27 Feb 13 olle 24     will generate warning messages later on.
1887 27 Feb 13 olle 25  7. Go to the Extensions->BRCA-Reg menu. Select the 'Installation wizard'
1887 27 Feb 13 olle 26     If the 'BRCA-Reg' menu is not visible try BASE->Reload permissions menu.
1885 27 Feb 13 olle 27  8. It should display a list with several error message about missing items.
1885 27 Feb 13 olle 28     Click on the "Create missing items" button to create them.
1885 27 Feb 13 olle 29  9. Manual fixes. Check the release information if any manual changes are 
1885 27 Feb 13 olle 30     needed to items that already exists in BASE.
1885 27 Feb 13 olle 31 10. Done. 
1885 27 Feb 13 olle 32
1885 27 Feb 13 olle 33 == Using ==
1885 27 Feb 13 olle 34  
1887 27 Feb 13 olle 35 BRCA-Reg appears as a menu entry in the Extensions menu. All operations
1885 27 Feb 13 olle 36 are available on that page. 
1885 27 Feb 13 olle 37
1885 27 Feb 13 olle 38  * Installation wizard:
1885 27 Feb 13 olle 39    This entry is available if the logged in user is an 'Administrator' and
1887 27 Feb 13 olle 40    will perform some basic checks that items that are needed by BRCA-Reg
1885 27 Feb 13 olle 41    exists and have been properly configured. Items that doesn't exists can
1885 27 Feb 13 olle 42    be created automatically.
1885 27 Feb 13 olle 43    
1885 27 Feb 13 olle 44  * Personal information registration wizard:
1885 27 Feb 13 olle 45    This entry is available for 'Administrators' and members of the 
1885 27 Feb 13 olle 46    'PatientCurator' group. It is used to register new patients and
1885 27 Feb 13 olle 47    cases and connect this information to (already existing) 
1885 27 Feb 13 olle 48    specimen tubes. It can also be used to update missing information
1885 27 Feb 13 olle 49    on existing cases and specimen tubes.
1885 27 Feb 13 olle 50  
1885 27 Feb 13 olle 51  * Blood referral form registration wizard
1885 27 Feb 13 olle 52    This entry is available for 'Administrators' and members of the 
1885 27 Feb 13 olle 53    'PatientCurator' group. It is used to register blood samples
1885 27 Feb 13 olle 54    and connect them with patients. The patient doesn't have to exists.
1885 27 Feb 13 olle 55    If the blood sample already exists, the wizard can be used to update
1885 27 Feb 13 olle 56    missing information.
1885 27 Feb 13 olle 57
1885 27 Feb 13 olle 58  * Referral form registration wizard:
1885 27 Feb 13 olle 59    This entry is available for 'Administrators' and members of the 
1885 27 Feb 13 olle 60    'PatientCurator' group. It is used to connect scanned referral
1885 27 Feb 13 olle 61    forms (eg. pdf files) to already existing cases.
1885 27 Feb 13 olle 62
1885 27 Feb 13 olle 63  * Consent form registration wizard:
1885 27 Feb 13 olle 64     This entry is available for 'Administrators' and members of the 
1885 27 Feb 13 olle 65    'PatientCurator' group. It is used to connect register consent
1885 27 Feb 13 olle 66    for participating in the study.
1885 27 Feb 13 olle 67    
1885 27 Feb 13 olle 68  * Specimen tube registration wizard:
1885 27 Feb 13 olle 69    This entry is available for those with permission to create samples.
1885 27 Feb 13 olle 70    It is used to register new specimen tubes for cases that are not yet
1885 27 Feb 13 olle 71    in BASE.
1885 27 Feb 13 olle 72  
1885 27 Feb 13 olle 73  * Partition registration wizard:
1885 27 Feb 13 olle 74    This entry is available for those with permission to create samples
1885 27 Feb 13 olle 75    and extracts. It is used to register new partitions of existing
1885 27 Feb 13 olle 76    specimen tubes.
1885 27 Feb 13 olle 77    
1885 27 Feb 13 olle 78  * DNA/RNA extraction wizards
1885 27 Feb 13 olle 79    Wizards for registering the extraction of DNA and RNA from the
1885 27 Feb 13 olle 80    sample material.
1885 27 Feb 13 olle 81
1885 27 Feb 13 olle 82  * Histology wizards
1885 27 Feb 13 olle 83    Three wizards used in the process of creating H&E stained glass
1885 27 Feb 13 olle 84    slides. The first wizard creates a printable lab tracking protocol
1885 27 Feb 13 olle 85    for the current batch biomaterial items that are about to be
1885 27 Feb 13 olle 86    processed. The second wizard records the paraffin embedding step,
1885 27 Feb 13 olle 87    and the last wizard records the H&E staining step.
1885 27 Feb 13 olle 88
1885 27 Feb 13 olle 89  * RNA quality control wizards
1885 27 Feb 13 olle 90    Three wizards that are used in the RNA quality control workflow. The
1885 27 Feb 13 olle 91    first wizard is used for placing the RNA aliquots on a Caliper or
1885 27 Feb 13 olle 92    Bioanalyzer plate. The second wizard generates a sample name file that
1885 27 Feb 13 olle 93    can be used by the Caliper software. The third wizard import the results
1885 27 Feb 13 olle 94    from Caliper back into BASE.
1885 27 Feb 13 olle 95
1885 27 Feb 13 olle 96 == Compiling ==
1885 27 Feb 13 olle 97
1885 27 Feb 13 olle 98 To compile this package you also need:
1885 27 Feb 13 olle 99  
1885 27 Feb 13 olle 100  1. Ant 1.6
1885 27 Feb 13 olle 101  2. Java 1.6
1885 27 Feb 13 olle 102
1885 27 Feb 13 olle 103 Follow these instructions:
1885 27 Feb 13 olle 104
1885 27 Feb 13 olle 105  1. Download the source code from the subversion repository. See
1885 27 Feb 13 olle 106     http://baseplugins.thep.lu.se/wiki/net.sf.basedb.brcareg for instructions.
1885 27 Feb 13 olle 107  
1885 27 Feb 13 olle 108  2. Type `ant download-lib` to automatically download the BASE core JAR files that
1885 27 Feb 13 olle 109     are neeed for compilation. You can also do this manually by copying the 
1885 27 Feb 13 olle 110     base-*.jar files from the BASE installation directory 
1885 27 Feb 13 olle 111     (<basedir>/www/WEB-INF/lib/) to the ./lib/compile directory.
1885 27 Feb 13 olle 112
1885 27 Feb 13 olle 113  3. Type 'ant' to compile the code and generate the 'brcareg.jar' file
1885 27 Feb 13 olle 114     in the project directory.
1885 27 Feb 13 olle 115
1885 27 Feb 13 olle 116  4. Use 'ant package' to create a downloadable tar.gz package.
1885 27 Feb 13 olle 117  
1885 27 Feb 13 olle 118 Tip: If you need different values for any of the properties defined in
1885 27 Feb 13 olle 119 the 'build.xml' file, create a file named 'build.properties' and set
1885 27 Feb 13 olle 120 the values there.
1885 27 Feb 13 olle 121

Generated on Tue Nov 21 03:23:35 2023 (UTC) by svndigest 0.11.2pre (dev build 1672)