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

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

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