Professional Documents
Culture Documents
User Guide AmericanEnglish
User Guide AmericanEnglish
Version 6.11a
"Tenset" and "Breeders Assistant" are registered trademarks of Tenset Technologies Ltd in the United Kingdom.
Breeders Assistant v6.11a – User Guide
Table of Contents
About This Document 1
1. Sources Of Help Information 2
2. License Agreement 3
3. Editions Of Breeders Assistant 4
4. Creating A New Database 7
5. Checklist For Customers Who Don't Want To Use The First Steps Tutorial 8
6. Migrating From Earlier Versions 9
7. Fundamental Concepts 10
7.1. Cat Database Files 10
7.2. Records 10
7.3. Fields 11
7.4. Indexes 11
7.5. Forms And Pedigree Layouts 12
7.6. Printer/Paper Configurations 12
7.7. Text Styles 12
7.8. Breed And Cat Title Data Files 13
7.9. Text Expansions 13
7.10. Field Codes 13
7.11. Macros 14
19. Ancestors 94
19.1. Entering Ancestors 94
19.2. Importing Ancestors 95
19.3. Tagging Ancestors 95
19.4. Ancestor Highlighting 95
19.5. Ancestors Listings 96
19.6. Ancestors Analysis 96
19.7. Mate Selection, Kinship And Population Analyses In The Extended Edition 97
20. Descendants 98
20.1. Tagging Descendants 98
20.2. Descendants Analysis 99
20.3. Reverse Pedigrees 99
20.4. Breedings Listing 100
If you obtained Breeders Assistant by downloading it from the Tenset website you might not have the British English version; it
depends exactly which files you downloaded.
The copyright in this software product is either owned by or exclusively licensed to Tenset Technologies Limited.
This software
product and all associated documentation including help files, PDF documents, and the information contained therein, are protected
by International Treaty provisions.
No part of this PDF document may be reproduced or transmitted in any form or by any means,
electronic or mechanical, including photocopying and recording,
for any purpose, without the express written permission of Tenset
Technologies Limited.
- Tenset and Breeders
Assistant are registered trademarks of Tenset Technologies Limited in the United Kingdom.
- All other respective trademarks acknowledged.
Help Reference - A source of reference material including lists of fields and indexed step-by-step instructions for most
tasks.
The Help Reference is accessed through the Help menu.
Breeders Assistant website - See www.tenset.co.uk.
2. License Agreement
Breeders Assistant is sold subject to the terms and conditions of a License Agreement.
To display or print the License Agreement
Help|License Agreement.
Installing and using the software requires you to review and accept the License Agreement.
Note also that Breeders Assistant is available in different "editions".
The edition you have is a choice made when purchasing a
license.
Some features are only available in the Professional or Extended edition.
Editions are described in more detail in the next section.
Personal Edition
This is the 'entry level' product which will store breeding records - the cats and associated information such as mating records - and
print pedigrees and related documents and compute inbreeding.
With the Personal Edition the software must be licensed into a personal name, which is normally your name in the way
that you would put it on a pedigree.
It may not be a non-personal name, such as breeding name or a club/organization.
There is a separate area on pedigrees for the breeder logo.
The license name will appear as part of a small line of text
near the bottom of printed documents, including pedigrees.
Databases are limited to at most 75,000 records of each type, per database. So a single database can contain at most
75,000 cats, 75,000 contacts, etc.
Professional Edition
This includes all the features of the Personal Edition but in addition:
The license name need not be a personal name. E.g. it can be an organization name or breeding name, prefix, affix name
etc.
The database record limit is 1,000,000 records of each type, per database.
It has an enhanced tagging facility.
Instead of a single tag per record there can be up to 8 different tags for each record
type (cats, contacts, etc.).
Each tag has a name and symbol.
Tags can be assigned to individual records, either manually
or as a side effect of another operation such as an ancestor/descendant search or a database inconsistency check (to
detect discrepancies such as cats being recorded as born before their parents etc.).
Once tagged you can quickly browse
the tagged records e.g. for review.
For further information see the "Tagging With The Professional/Extended Edition"
tutorial.
The Professional Edition can tag adjacent records in an index sorted on a given field.
This is a useful technique for e.g.
locating cats that the share the same registration number. See section 12 "Detecting Records With Duplicate Text Field
Values" (p.21) of the 'Working With Data' Tutorial.
User defined ancestor highlights allow you to define custom highlighting methods to highlight the ancestors within
pedigrees.
See section 15 "Using Custom Ancestor Highlighting With Duplicate Field Values" (p.26) of the 'Working With
Data' Tutorial.
Probability Analysis can predict whether an individual will inherit a given gene, or the probable 'value' for a polygenic
trait, based on the prevalence of the gene in its ancestors.
Gene Frequency Analysis can analyse the distribution of
different alleles over a set of individuals.
Extended Edition
This includes all the
features of the Professional Edition but in addition:
The Extended Edition includes a set of powerful population analysis and mating prioritization (mate selection) tools for
advanced breeding programmes and for management of genetic diversity in small (closed) populations.
The population analysis tools can analyse a group of cats and produce reports for various metrics such as inbreeding
coefficients, ancestral inbreeding, mean kinships, pedigree completeness indices,
founder metrics (including the number
of founder equivalents, the number of founder genome equivalents, and the number of 'effective ancestors' for a
breeding population, and for each founder the proportion of alleles retained and contribution to the current population),
and genome uniqueness metrics (to detect under-represented founders in the current breeding population).
The mating selection tools can analyse a set of potential matings and rank them (i.e. prioritize them) in various ways e.g.
to minimize the inbreeding in the potential offspring, or to maximize the influence of specific cats.
It can also rank
potential matings to try to preserve genetic diversity within a breeding population by maximizing the influence of
founders that are under-represented in the current breeding pool, and/or to
minimize inbreeding, and/or to minimize
mean kinship, or any combination of these methods.
The license conditions are varied to permit certain commercial use.
Specifically, you may exploit the product for
commercial gain of any printed output generated by it e.g. to run a pedigree service bureau. This is not permitted with
the Personal or Professional Editions.
Text fields can be configured to auto-increment - useful e.g. for a breed club or registry that wishes to auto-allocate
values for these fields such as registration numbers.
It can automatically detect duplicate text field values - e.g. to detect duplicate registration numbers on data entry.
It has an inconsistency name check to detect similarly named cats across an entire database.
See:
'Working With Data' Tutorial - 12 Detecting Records With Duplicate Text Field Values (p.21)
'Working With Data' Tutorial - 15 Using Custom Ancestor Highlighting With Duplicate Field Values (p.26)
(Or Higher)
Help Reference - A.72 Procedures By Subject: Professional Edition
If you have existing pedigree data (stored in text/CSV format) you probably want to import it into Breeders Assistant.
There is an easy way to do this: when you start a new pedigree database one of the options is to initialize the file with data
imported from a text/CSV file.
Select that option and proceed.
Please note there is a tutorial that explains in detail how to import text/CSV data (to view this select Help|Tutorials).
One of the options when creating a database is to populate it with sample data.
Several of the tutorials have been written with the
expectation that you have included this sample data.
It saves time since there is then no need to add the data manually and you
can instead focus on what the tutorials are describing.
Please note that if you're using the "Mate Selection, Kinship And Population Analysis" tutorial it is important that you select the third
option - to add mate selection, kinship and population analysis test data - when creating a new database.
The worked examples
described by this tutorial expect you to have this data available.
5. Checklist For Customers Who Don't Want To Use The First Steps
Tutorial
If you haven't looked at the "First Steps" tutorial yet, it is strongly recommended that you do so since it will probably save you time
in the long run.
It introduces the key parts of the software.
To access this - and other tutorials - select Tutorials from the Help
menu within Breeders Assistant.
But if you still don't want to do that, and are faced with the opening screen of the software, here are some things to try to get
started.
Create a new database (choose Database|New) and choose the second option - to populate it with sample data.
To change the display on the right side of the main window - e.g. to switch to a different pedigree layout - click the
Display button (above the top-left corner of the right side of the main window).
Take some time to explore the different
forms available on this menu, especially the pedigree layouts.
To add a new record e.g. a cat, select Record|Add Record ( Keypad+); when adding a cat be sure to move to the
Ancestors tab to enter the parents.
Note: the "First Steps" tutorial shows you in detail how to use this window to enter
ancestors.
It might not be obvious to you how you do this, which is one of the reasons why you should use the tutorial.
To modify (update) a record, just double-click it in the record list on the left side.
To change record type - e.g. from cats to contacts - click in the Work With box above the record list on the left-hand
side.
In Breeders Assistant you normally work with one record type at one time and this is how you switch (though there
are some notable exceptions to this general rule e.g. you can add new contacts 'in situ' as you add cats to the database).
To see the full range of fields in the record details windows be sure to turn on the 'advanced record' preferences: select
Configure|Preferences ( Ctrl+E), move to the User Interface tab and then enable each of the 'advanced record'
options.
To customize a displayed pedigree layout, do one or both of these:
1. select Form|Design Mode and then double-click on the parts you want to alter; when you see buttons
labeled Change, click them to select fields for the pedigree; or
2. select Form|Form Properties to change the borders or watermark.
To open the file use Database|Open ( Ctrl+O) to locate and open the file.
Once opened, save it with a new file name - use
Database|Save As.
NOTES:
Breeders Assistant version 6 does not support forms with PDF files as background images, such as some registration forms, that
were provided by Breeders Assistant version 4.
7. Fundamental Concepts
Contents
7.2. Records
7.3. Fields
7.4. Indexes
Title Data Files
7.11. Macros
8. Cat
Database Files
Backups
8.2. Cat Database Files:
There are various different types of fields that are used for different types of data:
text fields - These store a single line of text
multiline fields - Similar to text fields but these support multiple lines of text
flag fields - Yes/no or on/off values
date fields - Calendar dates
currency fields - Amounts of money
reference fields - Links to other records
e.g. the link from a cat to its (primary) owner is stored as a reference field, as
are the links from a cat to it's parents
time fields - Hours/Minutes
count fields - Whole numbers (i.e., integers)
The record list - in the main window - is simply a listing of records as defined by an index.
The name of the current index is shown
in the View box, just above the record list.
To change index click in View box to select another.
Within Breeders Assistant the terms index and view can generally be considered to mean the same thing.
A view is simply the
'display' of an index, as shown in the record list.
9.11.
Records, Fields And Indexes: Indexes
Breeders Assistant uses a mechanism called printer/paper configurations to handle differing printing requirements.
A printer/paper
configuration is a named collection of printer settings that includes all of the settings listed above.
Different printer/paper
configurations can then be used in different situations.
One of the properties of a document form is the selection of which printer/paper configuration it uses.
This provides a mechanism
for printer settings to be effectively varied from form to form.
E.g. it is possible to set up a customized printer/paper configuration
that prints using a large format printer, then associate it with a specific pedigree layout that prints, say, 6 generations of ancestors.
As another example it would be possible to have much smaller margins for a particular pedigree layout than on other forms, by
using a custom printer/paper configuration that has been set to use very small margins.
But perhaps the most common use of a customized printer/paper configuration is to provide the means to 'print' to a PDF document
rather than a physical printer.
This is covered in 13.3. Forms and Pedigree Layouts: Saving As PDF.
NOTES:
1. When
a database is first initialized it has some standard printer/paper configurations already set up.
These are designed to
print on the system default printer and they differ only in the paper orientation to be used - landscape or portrait.
They are called
'Default-Landscape' and 'Default-Portrait', and all the standard pedigree layouts etc. are set up to use them.
2. For this reason, to change the page margins of the standard pedigree layouts all that is necessary is to adjust the page margins
of the appropriate standard printer/paper configuration - probably 'Default-Landscape'.
To do this use Configure|
Printer/Paper Configurations, select the configuration to be adjusted then update the settings to alter the margins.
13.3.
Forms and Pedigree Layouts: Saving As PDF
Printing To PDF
22.3. Printer Configuration:
E.g. (2) the text style '4G - GG-P Name' is used when formatting the name of a great-grandparent within a 4 generation pedigree.
In order to change the fonts and font sizes used in a pedigree layout you should alter the underlying text styles.
To do this use
Configure|Text Styles.
It is also possible to define additional text styles, and then customize forms (see 13.7. Forms and Pedigree Layouts: Customizing
Forms And Creating New Forms)
and printed reports
to use those styles.
It is also possible to define additional text styles, and then customize forms and printed reports to use those styles.
See:
13.7.
Forms and Pedigree Layouts: Customizing Forms And Creating New Forms
See Also:
8.11.
Cat Database Files: Application Data Folder
7.10.
Fundamental Concepts: Field Codes
13.23. Forms and Pedigree Layouts: Formatting Instructions And Format Codes
Some field codes are not associated with actual data fields, but are created 'on the fly'.
E.g. cat records have no field that stores the
inbreeding coefficient.
But there is a field code <InbreedingCoefficient>.
When this is used in a form such as a pedigree layout
the inbreeding coefficient is calculated as needed and output.
E.g. a cat record uses a reference field to link to the contact record for its (primary)
owner. The field code for this link is <Owner>.
If
a customized pedigree form includes the text expansion "Owner: <Owner>" this is then replaced in the displayed form/pedigree/etc.
with the owner's full name e.g. "Owner: John Smith".
However, contact records also have fields and hence field codes.
E.g. the field code <Address> for a contact record is the postal
address.
If it was required to display the owner address within a pedigree this could be done by concatenating the field codes
<Owner> and <Address> to make a single field code.
This is known as 'chaining' the field codes.
E.g. "Owner Address:
<OwnerAddress>" might expand as "Owner Address: 123 Main St".
Cat records also use reference fields to link to the sire and dam.
The field code for the sire is <Father>, and the field code for the
dam is <Mother>.
These can be chained in a similar way.
E.g. (1) <MotherFather> expands to the name of the maternal
grandfather. E.g. (2) <FatherFatherMotherRegNo> expands to the registration number of the dam of the paternal grandfather.
Some field codes have arguments (parameters) to alter the field output.
Parameters are given as series of comma-separated options
after the field code name.
The <InbreedingCoefficient> field code - which outputs the inbreeding coefficient - is an example of a field code that can accept
additional parameters.
These parameters either output other associated information such as the number of full generations of
ancestors found, or they alter the inbreeding computation in some way e.g. by changing the number of generations of ancestors
used in the calculation.
E.g. whilst plain <InbreedingCoefficient> will expand to be the inbreeding coefficient itself,
<InbreedingCoefficient,6> expands as the number of common ancestors found (i.e. present on both sides of the pedigree).
See
section 4.7 "Fields And Field Codes Reference: Cat Records" of the Help Reference.
See:
See Also:
Help Reference - 4.7 Fields And Field Codes Reference: Cat Records
The e macro has the syntax [eX,Y,TEXT] and what it does is to see whether TEXT is empty; if it is it expands to X else it expands to
Y.
If a % character occurs in Y it is replaced by TEXT.
In this case, if the <Sex> field code expands to some text - e.g. 'Male' - then the macro would be replaced with:
Sex: Male
But if the <Sex> field code expanded to nothing, as it would if the sex is not known for the cat in question, then the macro would
expand to:
Unknown sex
It is common practice for macros to be used alongside field codes and, when used in forms such as pedigree layouts, with format
codes.
Note that macros can be nested within each other, which can lead to some complex but powerful constructions.
For full details of all available macros see section 3 "Macros Reference" (p.4) of the Help Reference. The Help Reference is accessed
through the Help menu.
NOTE:
To include a literal opening square bracket itself within a text expansion, precede it with the backslash character.
I.e. \[.
This is not normally necessary with closing square brackets as they are only interpreted as macro terminators when preceded by
unprotected opening square brackets.
See:
13.23.
Forms and Pedigree Layouts: Formatting Instructions And Format Codes
See Also:
8.2. Backups
See:
WARNING:
It is your responsibility to keep regular backups of your database(s).
Breeders Assistant does not retain any off-
computer backups of your data, anywhere.
It does not save your data 'online' or 'in the cloud'.
It does not transmit your data over
the internet or keep your data anywhere else - except in the folder(s) where you keep your cat database files.
Taking regular backups will give you a lot of protection (though not complete protection) against the following risks:
Your computer is stolen or accidentally destroyed.
Your hard drive crashes, wiping out all your data on the computer.
Your computer becomes infected by a virus or other malware or ransomware, and has to be completely restored.
You, or somebody else, accidentally delete your database file(s).
A software error corrupts your database.
If any of the above events occur, and you don't have a good backup, you have lost all your data and short of entering it all again
there is nothing you can do.
So, you are strongly advised to implement a backup policy and stick to it.
You should adopt a backup policy appropriate to your needs and that's not too onerous to carry out regularly.
Here are some issues
you should consider:
How Much Data Can You Afford To Lose? - Or put another way, how many days/hours lost data are you prepared to
have to re-enter should you need to revert to a backup?
The answer to this question helps you decide the minimum
frequency with which you should do your backups.
What Media Are You Going To Backup To? - A good choice is to backup to a USB memory stick ('pen' drive) or an
external (removable) hard drive, etc.
Whatever you use, it is important that it is some kind of removable media that can
be stored physically apart from your computer.
There is no point having a backup if it gets stolen along with your
computer.
Keep backup media in a safe place, physically apart from your computer.
How Can I Be Sure My Backup Is Good? - A bad or incorrect backup is as good as no backup at all.
It is important to
periodically check the validity of backups.
It is surprising just how many people and organizations rely upon a backup
strategy that has never been tested - and is flawed - and yet only discover this when it really matters and they need to
restore a backup.
Cycle Your Backups - Dont make the mistake of having a single backup device, and then always backing up to it.
What
would happen, say, if a lightning strike destroys your computer at the very time you were backing up?
You've probably
lost both your only backup (the last one, that you were overwriting at the time), and your database on the computer is
gone.
Have a set of backup media (say 2 or 3 USB sticks) and cycle them.
Every so often, replace one with a new one, and
archive the replaced USB in long term storage.
Most media can become error prone and periodically replacing them is a
defence against this.
Do You Need to Backup the Breeders Assistant Registry Settings? - Breeders Assistant stores all actual data in
the database files - records, forms, printer/paper configurations, text styles and so on.
Other information is stored in the
Windows Registry - such as preference information.
Generally, if you were to lose this information it is easy to recreate,
and hence it is not so important to take regularly backups of it.
You may well choose not to back it up at all.
Detailed
instructions for saving and restoring the Breeders Assistant registry settings can be found in the Help Reference.
See:
See Also:
8.3. Cat Database Files: Using The Built In Database Backup/Restore Facility
Breeders Assistant has a built-in backup/restore facility that can be used to backup the currently open database
and, optionally, the
breed/titles data files, to/from an external drive.
To access this use Database|Backup and Database|Restore.
NOTE: If you have the Professional Edition (or higher), and have set up a user defined gene configuration, the built-in backup facility
will not backup your user defined gene configuration file.
You need to back this up separately.
See section 7 "Mendelian Genetics
Configuration Reference" (p.113) of the Help Reference.
A backup that has previously been created using the internal backup facility can be tested (checked) using Database|Test Backup,
without the need to actually fully restore it.
See:
8.4. Cat Database Files: Making A Manual Database Backup (Externally To The Software)
If you do not wish to use the internal backup/restore facility described above you should manually backup your database file(s).
To do this, use Windows File Explorer (or similar) to manually copy the database file(s) to an external device, which should then be
kept safely and securely away from the computer.
If you're not sure of the file name/location of your database, use Database|Database Properties.
This will give an overall
summary of the currently open database, including its full file location.
Note this will not the backup the breed/titles data files.
To do that you need to manually copy those from the Breeders Assistant
application data folder.
The breed/titles files are named catbreeds.dat and cattitles.dat and are always stored in that folder.
See:
8.11.
Cat Database Files: Application Data Folder
See Also:
8.5. Cat Database Files: Internally Maintained Copies Of Recently Saved Databases
WARNING:
This is not an automatic backup facility.
Breeders Assistant does not retain any off-computer backups of your data,
anywhere.
It does not save your data 'online' or 'in the cloud'.
It does not transmit your data over the internet or keep your data
anywhere else - except in the folder(s) where you keep your cat database files.
You are strongly recommended to keep effective backups of your cat database file(s), safely and separate (i.e. removed from) the
computer on which you are using Breeders Assistant.
See 8.2. Backups.
What this means is that, assuming you have not changed the default settings, the penultimate saved version of the current
database is always available in the same folder as the database itself, but with the extension .cd1.
If you suffer a mishap such as
you accidentally delete a large number of records and then save the database, you can usually recover from that by finding the .cd1
file, making a safe copy of that file under a new
name and changing the extension of the copied file back to .cdb, and then
reopening it with Breeders Assistant.
How To Retrieve An 'Internal Copy' Of A Database Using The Database Locator Tool
This is the easier of two methods for retrieving a copy of an internally saved database.
See Also:
6. Finally, run the software on the new computer, then select Database|Open ( Ctrl+O).
Navigate to the folder
where database has been copied, and open it.
If there are multiple databases, steps 2-6 above should be repeated for each database.
8.8. Cat Database Files: Automatically Opening The Most Recently Used Database
When Breeders Assistant starts, it will normally open the same database as most recently used on the same computer (and, from
the same user account).
This means that, if you only use a single Breeders Assistant database, you do not need to be concerned with having to open the
database 'by hand' each time the software is started.
This is controlled by a preference setting.
To alter it, select Configure|
Preferences ( Ctrl+E), move to the Misc tab, click the Rarely Changed Options button, then change the 'Load most recently
used cat database at startup?' option.
NOTE:
This repair facility will find, and recover from, some errors in a database but not all.
Depending on the cause of damage it
may not be possible repair every database. The repair process will automatically delete all damaged records located.
When you upgrade Breeders Assistant a database repair is often performed automatically when first opening your database after
installing the new version.
This is normal and does not imply that your database contains errors.
Available Checks
The full list of available database inconsistency checks is as follows:
That the sex has been entered.
That the sex of the sire is male, and the dam is female.
That there are no ancestor circularities (self-parenting errors) within the ancestors of each cat.
This check is available
with different depths of ancestors - 8, 16 and 32 generations.
NOTE: with a database that has very deep ancestral lines it
can take a very long time to carry out this check.
That the generation gap between a cat and both its parents is consistent with the minimum and maximum generation
gaps as specified using Configure|Preferences ( Ctrl+E).
That prefixes (cattery names) are unique - i.e. that each prefix is given for one and only one contact record.
That the show-specific fields (e.g. show kind, show status etc.) are consistent for all show records relating to the same
show.
That the class-specific fields (e.g. judge etc.) are consistent for all show records relating to a specific class at the same
show.
That kittens are recorded as being born before their parents.
That text fields that have been configured to detect duplicates during data entry have no duplicates across the entire
database.
Requires Extended Edition.
That there are no cats with similar names.
This test searches the database, for each cat record, to find any similarly
named cats and reports any found.
With a large database this check can take a long time to complete.
Requires
Extended Edition.
That the genotype of each cat is a possible genotype that could arise from the mating of its parents, when known.
I.e.
given the known genotypes of the parents, is it possible for the stated genotype of the cat concerned to arise when its
parents were mated?
Requires Professional Edition (or higher).
See:
9.1. Linked
Records
9.3. Fields
9.11. Indexes
9.12. Matching
Records
9.16. Autocompletion
See:
See:
Records
15. Cat
26. Vet Records
See Also:
See:
See Also:
Predefined Fields
Notes Field
include a multiline field called the 'Notes' field.
This is a free format field that can be used for any text you like and
All record types
is always found on the Notes tab of the record details window.
Admin Fields
Breeders Assistant maintains various administrative fields for each record - such as the date and time of last modification.
It can
also maintain a history field - a multiline field that is updated with each change to the record.
This feature is disabled by default.
To
enable it, select Configure|Preferences ( Ctrl+E), move to the Misc tab, click the Rarely Changed Options button and then
check the 'Maintain history field' option.
See:
Set An Initial Value - This allows a default value to be set for a field.
If you have the Extended Edition of Breeders
Assistant it is also possible to set this using auto-incrementing sequences, which can be useful e.g. for a club where it is
desired to assign a unique registration number (or similar) for each new record.
When an auto-incrementing sequence is used, the default value can be left empty - in which case whenever a record is
added (or updated when the field was previously empty), the field is set to the next
number in the sequence.
Alternatively, the default value can be set to a text pattern that includes a "*" placeholder for the value.
E.g. if the
default value is set to "R*" this would generate field values "R000001", "R000002", etc. as each new record is added,
assuming the auto-incrementing sequence starts at 1 and the padding width has been set to 6.
There are various situations where the software needs to determine whether a text field 'matches' a search pattern.
E.g. when
deciding whether to include a record in a custom index, or when using the 'advanced search' facility to locate records matching a
given set of conditions.
Such matches are determined by comparing the text field value with the search pattern - i.e. some text - in one of four ways.
Note
the comparison is always case insensitive e.g. 'Fred' is considered to be the same as 'FRED':
Exact Match - The text must match precisely.
Left Match - I.e. the pattern is a prefix of the field value, also known as left-hand truncation.
Right Match - I.e. the pattern is a suffix of the field value, also known as right-hand truncation.
Containing Match - I.e. the field value contains the match pattern anywhere.
See:
Date Formats
formats, choose Configure|Preferences (
To change the date Ctrl+E) and move to the Date tab.
Currency Formats
To change the currency formats, choose Configure|Preferences ( Ctrl+E) and move to the Currency tab.
When sorting an index, reference fields can be compared using a specified field in the target record - i.e. within the
record that the reference field links to.
E.g. when comparing cat records by the breeder reference, you might compare by
the last name/organization.
This makes it possible to set up indexes that are ordered according to referenced data, such
as a list of cats ordered by the breeder name.
When searching for specific records it is possible to set match conditions based on fields in the referenced records.
E.g.
to search for cats where the sire is a particular breed.
This would involve setting a match condition for the Sire
reference, then choosing the breed field of the sire record type (i.e., cat records) and the specifying the text of the
desired breed.
Flag Fields - Are used to store logical values: information that has either a yes or no value.
E.g. whether a given contact
is a vet or not.
The value of a flag field is not necessarily shown as "yes" and "no".
It depends on what the field is used for.
E.g. the sex
field is a flag field, but it is shown (by default) as "stud" or "queen".
Some flag fields can also be set to a 'don't know'
value.
This is the case for the sex field: for a cat its sex is either male, female, or unknown (though it's much better to
set the sex if known - certain features in Breeders Assistant require the sex to be correctly set to function).
Count Fields - These are used to store whole numbers e.g. 1, 2, 3 etc.
Time Fields - These are used to store time of day values e.g. 2:30pm.
The main use for time fields is with
appointment/task records.
See:
Breeders And Owners
See:
NOTE:
It is often not necessary to work with field codes directly.
This is because Breeders Assistant is supplied with many
different predefined forms - e.g. standard pedigree layouts - that can be customized without needing to work at the field code
level.
However, to access all possible customizations it is necessary to work directly with text expansions and field codes for
maximum flexibility.
A field code typically consists of the field name surrounded by angle brackets, e.g.:
<Name>
Field codes are case insensitive. I.e., <Name> is the same as <NAME>.
NOTE:
If it is necessary to include a literal opening angle bracket within a text expansion, precede it with the backslash
character. I.e.:
\<
This is usually not necessary with closing angle brackets as they are only interpreted as field code terminators when unprotected
opening angle brackets precede them.
Some field codes accept parameters that adjust the generated text.
These are described in section 4 "Fields And Field Codes
Reference" (p.10) of the Help Reference.
There are several types of field code, which differ according to the source of the text generated:
With these field codes the replacement text is the number of records that have the current (context) record as the target of a
reference field.
E.g. with contact records there is a field code <OwnedCount> that is the number of cats that have the given contact
record as their (primary) owner.
See section 4 "Fields And Field Codes Reference" (p.10) of the Help Reference.
See:
Breeders And Owners
Help Reference - 4.5 Fields And Field Codes Reference: System Field Codes
Help Reference - 4.7 Fields And Field Codes Reference: Cat Records
Data Types
Breeders And Owners
Indexes may be customized e.g. to change the sort ordering, or to change the columns that are shown when in the record list.
The index match conditions determine which records are included in an index.
If no match conditions are set the index includes all available records of the current type.
To change the match conditions for the current index use Index|Match Conditions.
The ordering of the records in an index is defined by a set of one or more fields.
There must always be at least one sort field
defined.
For cat records this is often the Name field.
Multiple sort fields can be used to add secondary orderings e.g. if an index is created using the date of death as the primary sort
order it would be commonplace to add Name as a secondary ordering.
To change the sort order for the currently displayed index use Index|Sort Order.
Index Columns
The columns that
are displayed in the record list are set separately for each index.
It is possible to change both the order of the
columns and the columns themselves.
To change the columns for the currently displayed index use Index|Columns.
To resize the columns simply drag the column separators; these sizes will then be remembered.
9.12.
Records, Fields And Indexes: Matching Records
See Also:
for Records
Help Reference - A.77 Procedures By Subject: Searching
This is the process in which a set of match conditions are applied to a collection of records to see whether they meet those
conditions.
Record matching occurs in various different situations, e.g.:
When searching for all the records that meet certain conditions (such as when using Record|Advanced Search
( Ctrl+Shift+S)).
E.g. (1) if you wanted a list of all contact records that are vets, or (2) if you wanted a list of all
contacts that live in the US or Canada.
When trying to find the first record listed in the record list that meets a specific condition (using Record|Find
( Ctrl+F)).
E.g. (3) if you wanted to find the first cat born in a given year.
If 2 or more field match conditions are used there is also a choice as to whether all conditions should match (so called restrictive
matching), or whether just any one condition need match (so called relaxed matching).
For the examples given above the match conditions would be:
E.g. (1) - All contacts that are vets.
In this case there is just one field match condition: the flag field Vet must be set to true.
E.g. (2) - All contacts that live in the US or Canada.
In this case there are two conditions: the text field Country must be set to
'United States', or the text field Country must be set to 'Canada'.
And because there are 2 conditions it is also necessary to select
relaxed matching.
E.g. (3) - find the first cat born in a given year.
In this case there are two conditions: the Date of Birth field must be no earlier
than January 1st of the given year, and also the same field must be no later than December 31st of that same year.
And since there
are 2 conditions it is also necessary to select restricted matching: both conditions must match.
See:
Another way records are added is as a side effect of adding some other record.
E.g. when adding a cat record, you may well want to
set up links to its sire, dam, breeder etc.
If the database does not already contain records for the sire etc., Breeders Assistant lets
you add those records at the same time.
I.e. you do not have to make sure that the target records for the links exist prior to making
those links.
Perhaps the best example of this is when adding a cat record and add its ancestors: the Ancestors tab of the Cat Details window
displays up to 4 generations of ancestors using an on-screen 'pedigree' - you can just select/create the ancestors in situ and
Breeders Assistant will create records for any ancestor for which there was not already a record, and link the records correctly.
For full details about the Ancestors tab and how to use it to enter a pedigree, please see section 4 "Setting The Ancestors" (p.9) of
the 'First Steps' Tutorial. To access this - and other tutorials - select Tutorials from the Help menu within Breeders Assistant.
These methods are manual methods: you are keying in the information.
It is also possible to import data in bulk if it is available
externally in a text/CSV file.
See 11. Importing Data.
Keyboard Shortcuts
Breeders Assistant provides various keyboard shortcuts to speed data entry if you prefer to use the keyboard (only):
F7 - to update the user defined fields for the selected record.
Ctrl+F2 - to view or update (modify) the details of the sire of the selected cat/mating.
This will be disabled (grayed
out) if the sire has not yet been set.
F3 - to set or change the dam of the selected cat/mating.
Ctrl+F3 - to view or update the details of the dam of the selected cat/mating. This will be disabled (grayed out) if
the dam has not yet been set.
F4 - to set or change the breeder of the selected cat.
Ctrl+F4 - to view or update the details of the breeder of the selected cat.
This will be disabled (grayed out) if the
breeder has not yet been set.
Shift+F4 - to go to the breeder's record - i.e. the breeder becomes the current record.
This will be disabled (grayed
out) if the breeder has not yet been set.
TIP: Use the "back" button on the toolbar (Alt+Left-Arrow) to undo this
(return to the selected cat).
F5 - to set or change the owner of the selected cat.
Ctrl+F5 - to view or update the details of the owner of the selected cat.
This will be disabled (grayed out) if the
owner has not yet been set.
Shift+F5 - to go to the owner's record - i.e. the owner becomes the current record.
This will be disabled (grayed out)
if the owner has not yet been set.
TIP: Use the "back" button on the toolbar (Alt+Left-Arrow) to undo this (return to
the selected cat).
See:
See Also:
'First Steps'
Tutorial - 4 Setting The Ancestors (p.9)
Keyboard Shortcuts
Breeders Assistant provides various keyboard shortcuts to speed data entry if you prefer to use the keyboard (only):
F7 - to update the user defined fields for the selected record.
Ctrl+F2 - to view or update (modify) the details of the sire of the selected cat/mating. This will be disabled (grayed
out) if the sire has not yet been set.
F3 - to set or change the dam of the selected cat/mating.
Ctrl+F3 - to view or update the details of the dam of the selected cat/mating.
This will be disabled (grayed out) if
the dam has not yet been set.
Ctrl+F4 - to view or update the details of the breeder of the selected cat.
This will be disabled (grayed out) if the
breeder has not yet been set.
Shift+F4 - to go to the breeder's record - i.e. the breeder becomes the current record.
This will be disabled (grayed
out) if the breeder has not yet been set.
TIP: Use the "back" button on the toolbar (Alt+Left-Arrow) to undo this
(return to the selected cat).
F5 - to set or change the owner of the selected cat.
Ctrl+F5 - to view or update the details of the owner of the selected cat.
This will be disabled (grayed out) if the
owner has not yet been set.
Shift+F5 - to go to the owner's record - i.e. the owner becomes the current record.
This will be disabled (grayed out)
if the owner has not yet been set.
TIP: Use the "back" button on the toolbar (Alt+Left-Arrow) to undo this (return to
the selected cat).
See:
See Also:
Help Reference - A.54 Procedures By Subject: Main Window and Data Entry
Manually
You can manually scroll up/down the record list using a combination of the scroll bar, page up/down and the up/down keys.
Using Find
above the record list, can be used to quickly jump to a particular record.
Or, you can use Record|Find (
The 'Find' box, Ctrl+F)
or Record|Advanced Find ( Ctrl+Shift+F)
to locate a record with a more specific condition.
Searching
Using Tagging
You can tag records in various ways, then you can move between tagged records. It is also possible to restrict the record list so it
only shows tagged records - use Tag|List Tagged Records Only ( Ctrl+H).
Tagging is introduced in the "First Steps" tutorial and, if you have the Professional or Extended Edition, is covered in more detail in
the "Tagging With The Professional/Extended Edition" tutorial.
To access these - and other tutorials - select Tutorials from the Help
menu within Breeders Assistant.
See:
9.12.
Records, Fields And Indexes: Matching Records
See Also:
TIP:
In order to see the Health tab in the Cat Details window it is necessary to have 'advanced cat records' enabled (select
Configure|Preferences ( Ctrl+E), move to the User Interface tab, check the 'Use advanced cat records' option and click
OK).
See:
TIP:
If the Del key doesn't appear to work, first click in the record list area to ensure it has 'keyboard focus'.
When deleting a record, any other records that have (non-mandatory) links to that record would normally have those links removed.
E.g. if you delete the record for a cat that happens to be the sire of other cats in the database, then the records for those other cats
will have the link to the sire record removed.
Sometimes, however, this is not what you want.
Using the same example, lets say that you had by mistake added two records for
the sire, but with the name spelled differently, one being incorrect.
When you discover this error, you will want to not only delete the
incorrect record, but also change all the links that other records have to the record being deleted, so they now link to the correct
record.
Whenever this situation occurs, Breeders Assistant will warn you and give you the option to replace all such links with a link
to another record of the same type.
E.g. imagine you have you have created two records for a cat called "Fred".
In one of them you have correctly spelled his name as
"Fred" but in the other you entered "Fredd" by mistake.
Furthermore, imagine that you have added other cats and have referenced
both these records as the sire - i.e. you have some cats recorded as being out of "Fred", and others out of "Fredd".
You then realize
your mistake and delete the erroneous record for "Fredd".
When you delete "Fredd" Breeders Assistant notices that there are links
to "Fredd" from other records - as the sire. It asks if you want to replace those links with references to another cat.
You accept this
offer, at which point you can select from a list of all the cats in the database.
You select "Fred" in the list, then click OK.
Breeders
Assistant then deletes the record for "Fred" and updates all those records that previously linked to "Fredd" so they now link to
"Fred" instead.
See:
E.g. with cats displayed in the record list and sorted by name, to jump to a given cat's record just enter the first few letters of its
name.
2. The Record|Advanced Search ( Ctrl+Shift+S) option - to search for records that match multiple conditions.
There is also a 'similarity search' facility; this will be described in the next section.
Incidentally, the difference between 'finding' records and 'searching' for records is that 'finding' is used to locate the first record that
matches a given set of conditions, whereas 'searching' is concerned with locating groups of records all of which meet given search
conditions.
Using Search
This is typically
used to search for records with given word(s) as part of the key fields (such as the cat name), though it can be
configured to search other fields too.
To use this, select Record|Search ( Ctrl+S).
You can enter a search pattern - somewhat like a search engine. It will then search for records where the search fields match any of
the given search terms.
The words must match the search fields exactly.
To use left matching (left truncation) use "*" e.g. to search
for cats with the name starting "Fred" enter "Fred*" (without the quotes) as the search pattern.
The operation will default to search the most commonly used fields.
To change the fields that are searched, use the Configure
button within the Search window, or select Configure|Advanced|Search Fields.
To set up a saved search, first use either Record|Search ( Ctrl+S) or Record|Advanced Search ( Ctrl+Shift+S) (above)
to set the search parameters, then select Record|Saved Searches|Add Last Search.
A name can be given to the search
parameters, and from this point on the search can be repeated by simply selecting the search name from the Record|
Saved Searches menu.
See:
TIP:
With the Extended Edition of Breeders Assistant it is possible to carry out a similarity name check across the whole
database as part of the database inconsistency checking facility - use Tools|Advanced|Detect Database Inconsistencies.
See:
8.10.
Cat Database Files: Database Inconsistency Checking
See Also:
Find & Replace - E.g. to change a given title as used by all cats - use Record|Find + Replace ( Ctrl+R).
Change Case - To change the case of a given field over multiple records - use Record|Advanced|Change Case.
E.g.
after completing an import you might realize that the imported cats all have their names in UPPER CASE, and you need
to change them all to be Title Case.
Transfer Field - For copying or moving the contents of one field to another over multiple records.
E.g. you might import
some data and then realize that within data you had imported, a user field actually belongs in another field.
E.g. if health
notes have been imported to a user defined field you can subsequently transfer them to the dedicated health notes field.
Use Record|Advanced|Transfer Field.
See:
See Also:
For a tutorial introduction to these features please refer to the "Tagging With The Professional/Extended Edition" tutorial. To access
this - and other tutorials - select Tutorials from the Help menu within Breeders Assistant.
Tagging Records
This color can be changed - select Configure|Preferences ( Ctrl+E), move to the User Interface tab, then change the
'Tagged color'.
There are shortcuts to navigate between tagged records in the record list:
F8 - Moves to the first tagged record.
Shift+F9 - Moves to the previous tagged record (i.e., searches upwards to the last tagged record).
There are menu equivalents to all the above keyboard shortcuts (use the Tag menu).
9.19.
Records, Fields And Indexes: Searching For Records
See Also:
'First Steps'
Tutorial - 15 Tagging (p.34)
11.1. Text
File Import Layouts
11.1.
Importing Data: Text File Import Layouts
Breeders And Owners
15.3. Cat Records:
See Also:
Text/CSV files can be imported that use either a delimiter to separate the columns, or they can have fixed width columns without
delimiters.
When setting up an import layout the choice between fixed width or delimiter separated should be made before
specifying the import fields; this is because the format chosen will affect the information needed for each field:
Fixed Width - Each field is always a fixed number of characters wide, with spaces used for padding to align the columns
in the import file.
Delimiter Separated - Each field is separated by a character such as a comma, TAB or semicolon.
You can optionally
also set up a field quotation character.
Field quotation is used to protect import fields that may contain the delimiter
character as 'real' data.
E.g. the following sample import data shows name & address information using comma delimiter with single character quotation on
the address field:
Mr, Fred, Bloggs, '17 High Street, Anytown, AB1 2CD'
NOTES:
1. If the import data contains a column for which there is no suitable field in Breeders Assistant to import it to, one option is to
import the column into a user defined field.
These fields (initially) have names such as "User Field 1".
Once imported the fields
can be renamed. See 9.3. Records, Fields And Indexes: Fields.
2. If the import data contains columns that, for whatever reason, you do not want to import, you can choose to import them to
the special 'Ignore' field.
Doing this will simply discard the data in that column as the import file is processed.
You can add as
many 'Ignore' columns as needed to the import layout.
3. If you have any control over the format of the import text/CSV file itself, it is recommended to use TAB delimited format
without quotation.
E.g. if exporting data from a spreadsheet for use in Breeders Assistant, save the data as 'Text (Tab delimited)'.
See:
Date Fields
Automatic/Manual Mode
Tagging
to have the input records tagged.
This can be useful when importing a large batch of data that you wish to manually
You can opt
check after the import has completed.
By tagging the imported records you can manually inspect them, quickly moving between the
imported records.
Diacritical marks are accents that are used in, typically, European languages e.g. Å and é.
They can be removed during import, e.g.
to convert Å to (A) or é to e.
Automatically Add New Titles to the Titles Data File - If a title is seen during during import that is not in the titles
data file it can be automatically added using the 'Default' title highlight style.
This will normally cause the cat's name to
be automatically highlighted in red in pedigrees etc.
Note, this only applies to titles supplied as separate import fields.
It
does not apply when a title is imported as part of the cat's name.
E.g. if importing a cat which is a Norwegian Champion,
a title that's not in Breeders Assistant's list of standard titles, then if this title was supplied as part of the cat's name - i.e.
the name is given as Norwegian Champion Fred Breeders Assistant would not recognize it; however if the name were
given as Fred and the title was given in a separate import field as Norwegian Champion, then with this option turned on,
Norwegian Champion would automatically be added to the titles data file and the cat's name will consequently be
highlighted in pedigrees etc.
Resolving Ambiguities
It is possible to control the
way the software treats ambiguous links when importing.
E.g. if the contact name Mrs Smith occurs as
the name of an owner during import when there are existing contact records with the names Mrs A Smith and Mrs B Smith, the
software needs to select one of those records as the 'link'.
With the 'Resolve Ambiguities' option enabled, Breeders Assistant will
prompt to manually resolve such ambiguities.
With the option disabled, it will choose either link itself.
This makes it possible to
quickly import data containing ambiguities without being forced to manually 'fix' every one.
However for accurate importation of
data containing such issues the ambiguity resolution option should enabled so the software will prompt to fix each ambiguity found.
See:
Breeders And Owners
12.1.
Exporting Data: Text File Export Layouts
See Also:
A text expansion is a line of text containing field codes and macros that are to be expanded for each record output.
This is a
powerful and highly configurable alternative to specifying the export format as a field list.
E.g. the following text expansion could be used to export the name, sire name, dam name, sex and inbreeding coefficient of cat
records with the columns separated by tabs:
<Name>[t]<FatherName>[t]<MotherName>[t]<Sex>[t]<InbreedingCoefficient>
To Export Records
layout has been defined, use Database|Export|Text File (CSV) to export the records themselves.
Once the text file export
See:
In Breeders Assistant you always work with one form at a time, and this is displayed in the form display area of the main window.
To switch to a different form click the Display button - this is just above the top left corner of the form display area - and select a
different form.
Each form has a name that is displayed above the form display area, to the right of the Display button.
E.g. one of the standard
pedigree layouts included with the product has the form name Pedigree - 4G Copperplate - With Signature.
The Display button provides access to all forms using a hierarchical menu structure.
This menu structure is created from the form
names.
It is possible to customize existing forms and add new forms to the menu.
When naming new forms it is helpful to adhere to the existing naming convention, that is to say to use dashes(-) with spaces either
side to separate parts of the name.
The dashes are used by Breeders Assistant to organize the form names into the menu hierarchy
that that is shown when the Display button is clicked.
E.g. if you add a own custom pedigree form, don't simply call it something like My Pedigree Layout.
Instead, call it Pedigree - My
Layout.
This way it will appear in the Pedigree section of the popup menu you see when you click the Display button.
Note there
must be a space before and after the dash.
Contents
13.8. Watermarks
13.9. Borders
13.11. Boxes
See Also:
See:
See Also:
22.3.
Printer Configuration: Printing To PDF
for a cat does not mean that you always want it to appear in its pedigree.
E.g. registration numbers are not always wanted in
printed pedigrees even if they have been entered.
1. To enter the photo for a cat, make sure it's record includes the photo. Select Record|Update Record ( Enter).
If
you have the 'advanced cat records' setting enabled, move to the Pictures tab and enter the photo as picture #1.
If
you have the 'advanced cat records' setting turned off, enter the photo on the General tab.
The full file name should
be entered.
Generally the best way to select the photo is to click the button button (to the right of the photo file
name box).
2. To display a pedigree layout that includes the photo, click the Display button, select Pedigree from the menu, then
locate a style that includes space for the photo.
E.g. Pedigree|4G Copperplate|With Picture.
Including a photo for a cat and printing a pedigree is also demonstrated in section 10 "Setting Photos" (p.23) of the 'First Steps'
Tutorial. To access this - and other tutorials - select Tutorials from the Help menu within Breeders Assistant.
See:
'First Steps'
Tutorial - 10 Setting Photos (p.23)
13.7. Forms and Pedigree Layouts: Customizing Forms And Creating New Forms
A Breeders Assistant database is initialized with standard forms.
These may be customized in various ways:
Change or customize the printer/paper configuration.
E.g. this is how to change the paper size, paper margins, and any
other printer-specific settings.
Specify the watermark picture, if any, to be displayed 'behind' a form's contents.
Set or customize the border, if any, to be drawn around the form's contents.
Customize the contents and appearance of many of the boxes that make up the document's layout. This is perhaps the
most important aspect of form customization.
E.g. with a pedigree this is how to alter the information that is included in
the printout, such as whether to include the inbreeding coefficient etc.
New Forms
In addition to
changing details of existing forms it is possible to create new ones.
Once created a form can be further customized
using the methods outlined above e.g. to specify a watermark picture.
To create a new form use Form|New Form.
This is covered in more detail in section 12 "Creating A New Layout" (p.28) of the
'Pedigree Layouts' Tutorial.
See:
This is demonstrated in more detail in section 3 "Setting A Watermark Image" (p.6) of the 'Pedigree Layouts' Tutorial. To access this
- and other tutorials - select Tutorials from the Help menu within Breeders Assistant.
Breeders Assistant provides various options to adjust the watermark display, including:
Brightness - It can fade the photo for you.
Positioning - The watermark may be aligned to the center or any corner/edge of the form.
The image can be shifted by
specific distances in the X and Y directions.
Size - The watermark may be stretched to fill the form background, with an option to have 'bleeding' - whether or not to
include or exclude the paper margins.
If the image is not stretched it can be tiled instead.
See:
In addition to setting borders around the page they may also be set on a box-by-box basis.
See:
This is demonstrated in more detail in section 7 "Adjusting The Logo" (p.14) of the 'Pedigree Layouts' Tutorial. To access this - and
other tutorials - select Tutorials from the Help menu within Breeders Assistant.
See:
13.12.
Forms and Pedigree Layouts: Design Mode
See Also:
13.9.
Forms and Pedigree Layouts: Borders
Boxes
See Also:
13.11.
Forms and Pedigree Layouts: Boxes
See Also:
Positioning
and vertical positions of a box are set separately.
Either can be set to be:
The horizontal
relative to a boundary of the printable page, or
relative to another box
The 'printable page' simply means that part of the paper less the margins.
The paper and margin sizes are determined by the
printer/paper configuration with which the form is associated.
When positioning relative to another box, the box can either be
positioned completely to the left/right/above/below the other box, or it can be positioned relative to a side of the box.
In addition to setting the overall horizontal/vertical position, it is also possible to specify the spacing (gap) between the box and
whatever it is aligned to.
This is either set as an absolute amount (e.g. 0.1 inch) or as a percentage of the width/height of the page
or another box.
Size
NOTE:
In general, it is better to avoid fixed amounts for box sizes, because it makes life difficult if you subsequently adjust the
size of the printable page - e.g. by changing the margins, or by changing the printer or even, in some cases, just the printer
driver software.
All the standard forms supplied with the software use box sizing that is relative to the page size.
Background color
background color, which defaults to transparent (no color).
Every box has its own
NOTE:
Ancestor boxes optionally allow the background colors of the ancestor cells and generation titles to be set separately;
these colors take precedence over the 'overall' box background color.
Page Spanning
is generally only used in simple text boxes that completely fill the printable page, and when the box is designed
This is a setting that
to display information that varies widely in height.
E.g. the various 'Record Details' forms.
Enabling page spanning means that the box can extend over multiple printed pages if its contents, for any given record, are too high
for a single page.
In general it is recommended that this setting is not changed.
13.9.
Forms and Pedigree Layouts: Borders
See Also:
E.g. within a tabular pedigree layout there is a grid for the ancestors.
Each cell in the grid is actually a text area.
If you examine a
standard tabular pedigree produced by Breeders Assistant you'll note that for the Parents generation it probably has:
13.11.
Forms and Pedigree Layouts: Boxes
13.23. Forms and Pedigree Layouts: Formatting Instructions And Format Codes
See Also:
See:
13.10.
Forms and Pedigree Layouts: Calligraphic Text
13.8.
Forms and Pedigree Layouts: Watermarks
See Also:
'First Steps'
Tutorial - 10 Setting Photos (p.23)
Most of the standard forms included with the product use the first method.
See:
13.15.
Forms and Pedigree Layouts: Text Areas
See Also:
There are many settings that can be changed with a tabular ancestors box, giving considerable flexibility over how they appear and
allowing a highly customized appearance.
Number of Generations
NOTE:
For 7 or 8 ancestors in a pedigree certificate, it is generally necessary to have US ANSI 'B' or larger sized paper in order
to fit the most distant generation on the page.
Sideways Columns
Choose whether to have any number of the leftmost ancestor columns, starting with the parents, displayed sideways-on (vertically).
This is useful when trying to squeeze more generations into a pedigree and there is limited paper space.
If the first 2 or 3 columns
are set to be sideways-on they can often be made narrower as well, enabling the freed horizontal space to be reallocated to the
more distant ancestors.
Generation Titles
Choose whether to include a row along the top of the table for the generation titles ("Parents", "Grandparents", etc.).
Grid Style
styles of grid lines for the table:
There are four
Boxes - Non-touching boxes with uniform thickness lines.
Bracketed - Like a family tree on its side.
Table - A grid with uniform thickness lines.
Variable Table - A grid with with varying thickness lines.
This style emphasises the separation between the sire and
dam lines at each generation.
Choose the width of each column of ancestors, expressed in terms of the percentage of the overall width of the ancestors box.
This
allows the widths to be adjusted according to the level of detail of information included for each generation.
Select the details that are to be shown for each generation of ancestors.
It is normal to include the most information for the
parents, with less for the most distant ancestors.
There are two ways to set the details for each generation.
Either:
Choose from a list of options (name, breed, date of birth, etc.), and Breeders Assistant will choose an appropriate layout
for each cell in that column of ancestors.
Or, customize any given generation by setting up a 'text area' for cells in that ancestor column.
This is an advanced
customization, as it requires understanding of the formatting instructions that Breeders Assistant uses internally to
generate the text.
See 13.15. Text Areas.
Most of the standard pedigree layouts included with the product use the former method.
Ancestor Highlighting
The highlighting of ancestors within a pedigree - such as highlighting common or repeated ancestors - is handled separately to the
design of the ancestors box.
See 13.1. Ancestor Highlighting In Pedigrees for further details.
Fonts
used in a pedigree are controlled by text styles.
The fonts
Changing the fonts in a pedigree is demonstrated in section 10 "Adjusting Text Styles (Fonts)" (p.23) of the 'Pedigree Layouts'
Tutorial. To access this - and other tutorials - select Tutorials from the Help menu within Breeders Assistant.
See:
See Also:
'First Steps'
Tutorial - 20 How To Create A 5 Generation Pedigree (p.50)
NOTE:
The position and size of a circular ancestors box is specified as if it were rectangular, but when displayed it will be circular,
with the circle centered within the box.
Number of Generations
NOTE:
For 7 or 8 ancestors in a pedigree it is necessary to have US ANSI 'B' or larger paper in order to fit the most distant
generation on the page.
See:
See:
13.23. Forms and Pedigree Layouts: Formatting Instructions And Format Codes
See Also:
A (non-simple) text box contains a 'text area' comprised of multiple sets of formatting instructions.
See 13.15. Text Areas.
In comparison, a simple text box has just one set of formatting instructions. A text box contains different sets of formatting
instructions that are used to generate text aligned to different sides of the box.
Text boxes are most usually used in custom forms where there is a need to align text against 2 or more sides/corners of a box.
See:
13.7.
Forms and Pedigree Layouts: Customizing Forms And Creating New Forms
13.23. Forms and Pedigree Layouts: Formatting Instructions And Format Codes
See Also:
13.23. Forms and Pedigree Layouts: Formatting Instructions And Format Codes
This is an advanced topic.
The term 'formatting instructions' refers to text that generates the actual content that is displayed in forms.
In most situations these
formatting instructions are hidden from view, being generated internally depending on how the form has been set up.
Often there is
no need to deal with these because Breeders Assistant provides other, easier, ways to customize forms.
But for ultimate flexibility it
may be necessary to work directly with formatting instructions.
Formatting instructions are text expansions containing embedded 'format codes'.
Recall that text expansions are lines of text that in
turn contain embedded field codes and macros.
Often formatting instructions will contain all three.
When formatting instructions are 'expanded', it is done in the following order:
1. Field codes are replaced with the relevant text (usually from the current record).
2. Macros are executed.
3. Format codes are obeyed, in order to generate formatted paragraphs of text for display/printing.
Format Codes
A format code is
an embedded control sequence that starts with '{' and ends with '}'.
Format codes affect the appearance of text
within document forms.
E.g. the text {b+}some text{b-} would display 'some text' in bold.
For full details of all available format codes see section 5 "Format Codes Reference" (p.99) of the Help Reference. The Help
Reference is accessed through the Help menu.
Example
Consider
this simple example of a formatting instruction:
Breeder: [e,{i+}Unknown{i-},%,<BreederFullName>]
When this instruction is expanded, the field code <BreederFullName> is first expanded - if the breeder of the cat is not known, it
will expand to nothing, otherwise it is the breeder's full name.
Next, the [e,a,b,c] macro is expanded.
This macro expands to a if c is empty, else it expands to b; b can contain the special
character % which is replaced with the text of c.
So in this example, the macro does this: if the name of the breeder is not known, it
expands to {i+}Unknown{i-} else it expands to the breeder's full name.
Finally, format codes are interpreted.
Format codes generally affect the appearance and not the actual text (e.g. they can be used to
select bold text, change the font, etc.).
These are made up of text surrounded by braces {..}.
In this case, if the breeder was not
known, the partially expanded text will currently be
Breeder: {i+}Unknown{i-}
The {i+} and {i+} are codes that turn italic text on and off.
So when it is finally displayed it would be something like this:
Breeder: Unknown
See:
See Also:
They can be printed but the print quality is inferior when compared to document forms because they do not support format codes
nor any of the other layout facilities of document forms, such as borders, boxes or watermark images.
Text forms can be saved as text files, or copied to the Windows clipboard - right-click over the displayed text and select Save As or
Copy To Clipboard.
Text Forms
HTML Pedigrees
Mating records also include text forms designed to generate an HTML pedigree.
Cat, Mating and Trial
These are similar to text forms except that the content is generated internally (and cannot be edited), and there is an option to
preview the pedigree in a browser (right-click over the displayed HTML then select HTML Preview.)
See:
Watermarks
13.23. Forms and Pedigree Layouts: Formatting Instructions And Format Codes
See Also:
13.25. Forms and Pedigree Layouts: Transferring Forms Between Databases - Form
Import/Export
It is possible to transfer a form from one database to another.
E.g. to export a pedigree layout in order to add it to another database
or transfer to another user of the product.
This is a two step process.
First, the 'export form' facility is used to create a small file that contains the relevant form layout: display
the form and then use Database|Export|Displayed Form to save it as a file.
Next, this file is then imported into the target
database using Database|Import|Configuration Data.
See:
14.1. Names
Labels and Mailing Lists
14.4. Letters, Envelopes, Address
The Contact Record Details window can operate in either a 'normal' or 'advanced' mode.
In the advanced mode many more fields
are available.
To switch between normal and advanced mode, use Configure|Preferences ( Ctrl+E), move to the User
Interface tab and change the 'Use advanced contact records' option.
See:
Organization Names
When using a contact record for an organization the title and first names/initials should be left empty.
Place the whole organization
name in the last name/organization field.
Joint Names
To enter a joint
name but as a single contact record, e.g. Mr J K & Mrs A B Smith it is necessary split the text into 3 parts so that
when joined together they will read correctly as the joint name.
It is recommended to place the leading title in the title field, the last name in the last name/organization field, and the remainder in
the first names/initials.
E.g. with the above joint name, it should be entered as:
Title - Mr
First Names/Initials - J K & Mrs A B
Last Name/Organization - Smith
This may look a little strange but it retains the alphabetical ordering of contact names.
It also has the benefit that the joint name
can be used effectively in fields of cat records such as the (primary) breeder or owner.
Contact Titles
maintains a list of common contact titles such as Mr, Mrs, etc.
Breeders Assistant
When a contact record is added or updated using the Contact Record Details window the title can either be keyed in or it can be
chosen from the list of common titles.
This list can be customized using Configure|Advanced|Contact Titles.
Licensed Users
Breeders Assistant
requires that each licensed user of the software has a contact record in a database.
Whenever an existing database is opened - or a new one is created - a check is made that there are contact records for the licensed
user(s).
If missing they are automatically added.
It is not possible to edit the Title, First Names/Initials or Last Name/Organization fields for licensed user contact records.
See:
Breeders And Owners
15.3. Cat Records:
NOTE:
These lists only include cats where the given contact is recorded as the primary breeder/owner.
They do not cover cats
where a contact is recorded as being one of the 'additional' breeders/owners.
See 15.3. Cat Records: Breeders And Owners.
See:
Breeders Assistant maintains indexes of all contacts relating to sales and stud enquiries, purchases, etc. ordered by date.
These can
be accessed from the View box e.g. select the index Contacts who have bought kittens/cats from you to see at a glance all
your kitten sales.
NOTE:
To use these fields it is necessary to have 'advanced contact records' enabled (select Configure|Preferences
( Ctrl+E), move to the User Interface tab, check the 'Use advanced contact records' option and click OK).
See:
See Also:
14.4. Contact Records: Letters, Envelopes, Address Labels and Mailing Lists
It is possible to use a form for a letter or other document where the body of the letter includes details taken from the selected
contact record, e.g. name and address.
A sample letter form is included - a change of address letter.
To display this select Display|Letters|Change of Address.
To create a new letter form use Form|New Form, enter an appropriate name e.g. 'Letters - My Letter', click Next and then choose
a letter form template.
NOTE: Cat sale agreements (contracts), and mating agreements are accessed via the cat and mating records.
See 15.14. Cat
Records: Sale Agreements (Contracts) and 16.4. Mating Records: Mating Agreements.
Mailing Lists
There may be times where it is necessary to print the same form for many records - e.g. to send a letter to multiple contacts to
inform them of a change of address.
Breeders Assistant does not provide a dedicated mailing list facility as such.
However, it is
possible to use a combination of other features to get a similar effect.
When a form is printed - using Form|Print ( Ctrl+P) - there are options to select the records that are to be printed.
The default
is to just print the form for the current record - which in most situations is exactly what is wanted.
However there are other options
- e.g. to print all records in the current index, or to print all tagged records - and these can be used for mailing lists.
NOTE:
If this technique is used to print batches of envelopes or labels it is strongly recommended you make certain the printing
of single envelopes/labels is working first.
This is because the printer needs to be set up for the correct envelope size or label
layout. See 22.2. Printer Configuration: Standard Printer/Paper Configurations.
Achieving the effect of a mailing list in Breeders Assistant is therefore a matter of either:
...and then printing a form for all the specified records in a single step.
See:
Mating Agreements
Standard Printer/Paper Configurations
See Also:
15.1. Adding
And Updating Cats
15.6. Pictures/Photos
15.11. Breeds
Whilst it may appear that Breeders Assistant stores a pedigree for each cat, this is not actually the case.
The pedigrees that are
displayed in the main window are always worked out 'on the fly' as needed.
What happens is that, behind the scenes, the sire/dam
links between generations are followed and the required information 'pulled out' and included in the pedigree.
The only 'pedigree'
information that's actually stored with each cat are the links to the cat's sire and dam.
This is a fundamental concept to be aware of.
It means that the details of each cat are only stored once - in each cat's record.
An
important consequence is that when you fix an error in any cat's record - e.g. if the sire was wrong - this correction will
automatically appear in all pedigrees that reference that cat.
As another example, there is a misspelling in a cat's name, it need only
be corrected in one place and all other references to that cat, e.g. occurrences of it as an ancestor, are implicitly and automatically
updated.
Likewise if the title of a cat changes - e.g. it becomes a Champion - just change this in one place (its record) and the title
will automatically appear in all pedigrees containing the cat as an ancestor (and it will normally automatically display in red).
See Also:
Help Reference - A.54 Procedures By Subject: Main Window and Data Entry
To turn on advanced cat records, select Configure|Preferences ( Ctrl+E), move to the User Interface tab, then
check the 'Use advanced cat records' option.
Quick Cat Details window - This is designed specifically with keyboard input in mind.
It is accessed by a keyboard
shortcut - Ctrl+Keypad+ for a new cat, or Ctrl+Enter for an existing cat.
This contains only the most important fields for a cat: name, sex, sire, dam, date of birth and a few others.
There are no
tabs to navigate between, and no need to use the pointer for any part of its operation.
Usage of the Cat Details window is covered extensively in the "First Steps" tutorial. To access this - and other tutorials - select
Tutorials from the Help menu within Breeders Assistant.
See:
See Also:
Help Reference - A.54 Procedures By Subject: Main Window and Data Entry
Use of the Ancestors tab is covered extensively in the "First Steps" tutorial. To access this - and other tutorials - select Tutorials
from the Help menu within Breeders Assistant.
However there are alternative ways to set the sire/dam, which can be helpful if other generations of ancestors do not need to be
entered at the same time, or it is preferred to use keyboard input only.
To set or change the sire of the selected cat without changing any other data, use Record|More Data Entry Options|Sire|
Set/Change ( F2).
This displays a window containing just a link to the sire record. The link can be changed by clicking the sire
name and selecting from a pulldown list.
Or, use the '*' button to select a new sire:
To update or view the details of the selected sire, use Record|More Data Entry Options|Sire|Details ( Ctrl+F2) instead.
This
will open the Cat Details window but for the sire of the current cat (not the current cat itself).
Dams
Similar
facilities are available for the dam too.
Just use F3 instead of F2.
See:
Help Reference - A.54 Procedures By Subject: Main Window and Data Entry
The first breeder link is known as the 'primary' breeder, whereas the other 2 are 'additional breeders'.
The (primary) breeder/owner are set using the General tab of the Cat Details window.
This is demonstrated in the "First Steps"
tutorial. To access this - and other tutorials - select Tutorials from the Help menu within Breeders Assistant.
Note, when a cat is bred by 2 persons in a joint capacity - e.g. husband and wife are both breeders and all cats they breed are in
joint names - then it is normal to record them as the breeders of each cat using just the primary breeder link from each cat record -
but using a contact record that's set in joint names; see 14.1. Contact Records: Names.
I.e.:
Cat, Breeder #1 (primary) -> Contact record in the name of "Mr AB & Mrs CD Smith".
Contrast this with a situation where, say, a Mr EF Jones is the breeder, but has entered into some kind of breeding arrangement with
another breeder Mrs J Evans.
In this case it may be preferable to have 2 breeder links for the cat concerned:
Cat, Breeder #1 (primary) -> Contact record in the name of "Mr EF Jones".
Owners of cats are recorded in the exact same way - up to 3 separate contact records can be linked as owners of each cat, the first
of which is the 'primary' owner and the others are 'additional' owners.
Whenever the term 'the breeder' or 'the owner' is used without any other qualification within this documentation or the software
itself, it actually means 'the primary breeder' or 'the primary owner'.
NOTE:
To use the additional breeders/owners fields it is necessary to have 'advanced contact records' enabled (select
Configure|Preferences ( Ctrl+E), move to the User Interface tab, check the 'Use advanced contact records' option and
click OK).
When adding a cat, Breeders Assistant can automatically set the (primary) breeder if the name of the cat starts with a recognized
cattery name.
The cattery name is stored as a field in the contact records.
For further details see 15.7. Automatic Breeder/Owner
Detection by Cattery Name Prefix/Affix.
Names
Automatic Breeder/Owner Detection by Cattery Name Prefix/Affix
15.7. Cat Records:
See Also:
Registering Bodies
Primary Titles
of a cat is the title that prefixes the cat's name when it appears in documents such as pedigrees.
The 'primary title'
The primary title is given in both a long and a short form.
E.g. if Champion is the long form, CH might be the short form.
Breeders
Assistant automatically uses both types in different situations.
E.g. the short title is typically used when a cat's name appears as a
distant ancestor on some other cat's pedigree (to save space).
The Cat Details window has boxes for entering both the long and short forms.
When entering the primary title it is important to fill in both the short and long forms AND the title highlight style - the style is what
will cause the cat's name to be highlighted e.g. in red.
It is possible to select all these manually - just type them in and click the
Style box to select a highlight style from a list.
However there is a quicker way, which is to click the Choose From Standard Titles button.
This displays a list of common titles.
By selecting from this list both the short and long forms of the title are set, along with the title highlight style.
This list can be
customized - see 15.10. Titles Data File.
Both short and long forms of the primary title are simple text fields.
If a cat has multiple titles that are to appear as the primary title
they should be entered in the same box.
E.g. for a cat that is both Champion and Grand Premier, the long form of the primary title
should be set to 'Champion & Grand Premier' and the short form to 'CH & GR PR'.
Titles that appear after a cat's name are placed in the Additional Titles field.
This is a multiline field.
NOTE:
In order to see the fields for additional titles in the Cat Details window it is necessary to have 'advanced cat records'
enabled (select Configure|Preferences ( Ctrl+E), move to the User Interface tab, check the 'Use advanced cat records'
option and click OK).
Breeders Assistant uses separate highlighting of the additional titles from the cat's name and primary title.
E.g. the cat might be a
Champion with the word Champion and its name highlighted in red, but its after titles need not be highlighted or they could be
highlighted differently e.g. blue.
To select the highlight for additional titles click in the Style box next to the additional titles.
Whenever a cat's name appears in a document such as a pedigree it is optional whether the additional titles are included.
The
standard pedigree layouts generally include after titles for the subject cat and all but the furthest ancestors.
This can be changed if
required.
E.g. it might be desirable to have some pedigree layouts that include after titles and others that do not.
Changing these
settings is a case of adjusting the information included in the 'details box'.
An example that shows how to change the cat's details is demonstrated in section 8 "Adjusting The Cat Details" (p.16) of the
'Pedigree Layouts' Tutorial. To access this - and other tutorials - select Tutorials from the Help menu within Breeders Assistant.
See:
See Also:
Entering Pictures/Photos
Pictures/photos are entered in
the Cat Details window.
The data that is stored is the file name of the picture/photo.
The actual
image itself (i.e. the contents of the picture/photo file) are not copied to the database, and therefore the image files must remain
accessible whenever the image is needed to be displayed/printed.
Where exactly the photos/pictures are entered in the Cat Details window depends on whether or not the 'advanced cat records'
option is turned on (this is a preference setting - select Configure|Preferences ( Ctrl+E) and move to the User Interface tab
to change this).
With 'advanced cat records' turned off, only one picture/photo file name may be entered, and this is located in the General tab of
the Cat Details window.
With 'advanced cat records' enabled, up to 4 picture/photo file names may be entered using the Pictures tab of the Cat Details
window.
Using Pictures/Photos
The main use of pictures/photos is in pedigrees - e.g. as a watermark or within a 'picture box'.
It is also possible to include pictures
within the ancestors table of a pedigree - for a 'pictorial' pedigree effect.
Pictures/photos can also be used in logo boxes e.g. to set a
custom fixed image.
Pictures are included in documents such as pedigrees by way of a picture box - a rectangular area that is reserved for the image.
Such boxes can be configured to use any one of the 4 picture fields.
All the standard forms, pedigree layouts, etc. are set up to use
picture #1.
An example of a possible use of the multiple picture fields would be to reserve, say, picture #2 for a picture of the cat as a kitten.
It
would then be possible to have a custom pedigree cover sheet that includes a picture box for picture #2.
Folded pedigree 'booklets'
could then be produced where the front page always has a photo of the cat as a kitten, whereas the picture in the pedigree itself
might be the photo as an adult.
See:
Boxes
See Also:
E.g. if there is a contact record in the name of Colin Manning, with cattery name set to Arripay, and another contact record in the
name of Jane Evans with cattery name set to Hillsdown,
and a new cat called Arripay King John of Hillsdown is added, then
Breeders Assistant will normally automatically set the breeder to be Colin Manning and the owner to be Jane Evans.
If the breeder is known but the owner isn't, Breeders Assistant will normally assume the breeder is also the owner.
This behavior
can be disabled - select Configure|Preferences ( Ctrl+E), move to the Misc tab and disable the Assume breeder is owner
when auto-setting breeder from cattery name used as prefix option.
NOTES:
1. As the
cat's name is keyed in, Breeders Assistant will only perform the auto-lookup of the (primary) breeder/owner if they are
not currently set.
This is to avoid names previously entered from being unwittingly removed.
2. It is possible to manually force the breeder and/or owner to be re-evaluated using the prefix/affix mechanism - click the Set
From Prefix/Affix button.
See:
TIP:
In order to see the Transfer tab in the Cat Details window it is necessary to have 'advanced cat records' enabled (select
Configure|Preferences ( Ctrl+E), move to the User Interface tab, check the 'Use advanced cat records' option and click
OK).
When buying/selling kittens/cats, Breeders Assistant asks if an associated accounting record should be added to store details of the
financial side of the transaction.
In general, it is recommended to not enter data into the fields on the Transfer tab directly.
This is because there is a quicker way to
handle sale/purchase transactions that will also automatically add the associated accounting records if needed.
To record the sale of a kitten/cat first select the relevant cat in the record list then right-click over it and select the Record Sale of
this Kitten/Cat option.
Note the cat must be recorded in your database as being owned by you in order for the sale option to be
enabled.
Similarly to record the purchase of a kitten/cat select the relevant cat in the record list then right-click over it and select the Record
Purchase of this Kitten/Cat option.
In this case the cat must not be recorded in your database as being owned by you in order to
record a purchase of it.
See:
Records
15. Cat
Records
15. Cat
Title Entries
First, and most
importantly, it contains a set of title entries.
A title entry is simply the definition for a single 'title'.
It contains the
long form, the short form, and the highlight style to be used by default with this title, e.g. 'Champion', 'CH', and 'Default'.
Backing Up
If manual changes are made to the titles data file it is recommended to keep it backed up.
The internal backup facilities that Breeders Assistant provides for backing up cat database(s) can also backup the titles data file.
See
8.2. Cat Database Files: Backups.
The full range of available breed fields can be seen on the Breed tab of the Cat Details window.
When a cat is entered its a good idea to fill in some of the breed fields for use in pedigrees etc.
Certain fields are used more than
others and it is desirable that these fields in particular be filled in.
The more important fields are listed below:
FIELD PURPOSE
Full Breed The full description of the breed of cat. This description typically includes both the breed group and variety. This is
Description often used in pedigrees for the subject cat and its immediate ancestors.
E.g.:
Blue
Tabby Point Siamese
Short A shorter form of the description of the breed (breed group + variety) of cat. This is often used in pedigrees for the
Breed more distant ancestors. It can be the same as the full breed description. It doesn't have to be different and will often
Description be the same when the full form is already quite concise.
E.g.:
Blue
Tabby Pt Siamese
Siamese
Variety The 'variety' of cat. Typically this is the same as the full breed description but without the breed group. Normally it is
a combination of the color and/or pattern. Designed to be used on pedigrees where all cats are the same breed - as is
usually the case - but where the variety differs. Takes less space in the pedigree because the breed group is not
included.
E.g.:
Blue
Tabby
27b [GCCF]
0386 [CFA]
Breed details for a cat are set using the Breed tab of the Cat Details window.
One way to enter these - though probably not the best way - is to set each field separately for each cat.
They can be keyed in, or
there are pulldown lists to the right of most fields to select a common value.
If the breed data file has been initialized to use CFA breeds and you're comfortable with breed numbers a quick way to set the breed
for a cat is to simply key in the breed number into the breed number box.
As soon as a known breed number is entered all the fields
will be automatically set.
If this method is used it is recommended to set up the breed data file to include all breeds as appropriate.
If you work with EMS codes the same technique can be used by keying in the EMS code field - assuming initialized the breed data
file has been initialized to include EMS codes.
The breed data file is set up during installation of Breeders Assistant.
Please note that
there are preference settings that can be used to disable this behavior (select Configure|Preferences ( Ctrl+E)).
To add extra entries to the breed data file choose Configure|Breeds, then click the Add button and select Additional Standard
Breeds.
The normal way to set up the breed details for a cat is to use the Choose From Standard Breeds button in the Cat Details
window.
When this is clicked a list of standard 'breeds' is displayed; by selecting an entry from this list all the details for that 'breed'
are set in one step.
The list of standard breeds is stored in the breed data file and can be customized - see 15.12. Breed Data File.
Default Breed
up a default breed that will be used for new cats. See 15.12. Breed Data File.
It is possible to set
See:
Breed Entries
First, and most importantly, it contains a set of breed entries.
A breed entry is simply the definition for a single 'breed' or 'type' of
cat.
It contains the values for all of the 'breed' fields (as seen on the Breed tab of the Cat Details window) for a cat of that type.
E.g. the breed entry for Chocolate Tabby Point Siamese might contain:
Full breed description: Chocolate Tabby Point Siamese
Short breed description: Choc Tabby Pt Siamese
Breed: Siamese
Color: Chocolate
Pattern: Tabby
Variety: Chocolate Tabby Point
etc.
The second element to the breed data file are additional entries for the 'popup' lists of field values that are visible in the Breed tab
of the Cat Details window when the pulldown menus are clicked.
The options in these lists are constructed by taking all possible values for the given field in the breed data file plus any additional
entries that have been manually added.
To add entries choose Configure|Breeds then click the Edit Field Lists button.
Backing Up
If manual changes are made to the breed data file it is important to ensure it is backed up.
The internal backup facilities that Breeders Assistant provides for backing up cat database(s) can also backup the breed data file.
See 8.2. Cat Database Files: Backups.
With the Professional Edition (or higher) the operation of these fields is dependent on the gene configuration.
Please refer to 28.2.
Mendelian Genetics: Genotype Fields for details.
With the Personal Edition these fields are still present, but they are treated as plain text fields and Breeders Assistant will not
attempt to use them e.g. in any gene predictions.
Genotypes in a breed entry can be specified either as common to both sexes or separately for each sex.
The former method is most
often used.
The latter method is useful for sex-linked genes.
E.g. in cats, the O gene (red) is sex linked.
So a user of Breeders
Assistant for Cats might want to customize the breed data data file entry for, say Red Siamese, to include the genotype O for males
and OO for females.
NOTE:
None of the standard breed lists supplied with the product include filled out genotypes for any breed.
What is provided is
the mechanism to extend the standard breed data files to include these if it is needed.
See:
Genotype Fields
28.2. Mendelian Genetics:
See Also:
Breeders Assistant can produce a kitten/cat sale agreement (sale contract) where the details of the cat (name, date of birth etc.)
and the new owner are built into the text of the agreement.
A sale agreement is simply a form that includes a large area containing the text of the agreement and possibly a header.
The text
contains placeholders - text expansions - for the cat and owner details.
NOTE:
Please be reminded of the following clause from the Breeders Assistant License Agreement:
"The text of all sale
agreements contracts invoices or similar as supplied with Breeders Assistant are provided as samples only.
Tenset Technologies
Ltd. does not warrant the legal enforceability or correctness of any such contract or agreement or invoice or similar.
You agree to
engage your own solicitor or lawyer to draft agreements or contracts suitable to your needs and locality. You accept that in no
circumstance will Tenset Technologies Ltd have any liability with respect to any use of any sale agreement or contract or invoice
or similar generated by Breeders Assistant."
See:
Customizing Forms And Creating New Forms
'First Steps'
Tutorial - 21 Agreements/Contracts (p.55)
Database Files: Backups
8.2. Cat
With the Professional Edition (or higher) it is also possible to include predictions of the expected traits (colors etc.) in mating
certificates, litter pedigrees and trial mating pedigrees.
See 28. Mendelian Genetics.
Contents
Prediction Of Offspring
16.1. Genetic
16.2. Relationship Coefficient
See:
Mate Selection - Overview
29.5. Mate Selection, Kinship And Population Analysis:
See Also:
NOTE:
In order to see the Genotype tab in the Cat Details window it is necessary to have 'advanced cat records' enabled
(select Configure|Preferences ( Ctrl+E), move to the User Interface tab, check the 'Use advanced cat records' option and
click OK).
See:
Genotype Fields
28.2. Mendelian Genetics:
See Also:
7.10.
Fundamental Concepts: Field Codes
With the Professional Edition (or higher), it is possible to include genetic based predictions of likely traits, colors etc. that may result
from the mating. See 28. Mendelian Genetics.
A mating certificate form includes various boxes for details of the mating, the sire, dam etc.
It also includes a tabular ancestors box
that displays the ancestors of the sire.
The standard forms provided include 3 generations of the sire's ancestors.
These can be
customized in the same way as pedigree layouts can be customized.
In a similar way it is possible to add new mating certificate
designs with different generation depths.
A mating certificate can include an estimate of the expected date of birth.
This is computed by taking the start date of the mating
and adding on the gestation period for the dam (this is one of the fields within it's record).
If the record for the dam doesn't have
this set a default value can be used.
The certificate can also include an estimate of the date when any kittens arising from the mating may go to new homes.
This date is
computed by adding a given number of days to the expected date of birth.
The number of days is stored as a field in each mating
record; the default is a preference setting.
If the default value is itself not set, the 'ready by' text is excluded from the standard
mating certificates.
It is also possible to include the coefficient of inbreeding of any offspring that will arise from the mating, and/or the coefficient of
relationship between the parents.
See:
Relationship Coefficient
See Also:
NOTE:
Please be reminded of the following clause from the Breeders Assistant License Agreement:
"The text of all sale
agreements contracts invoices or similar as supplied with Breeders Assistant are provided as samples only.
Tenset Technologies
Ltd. does not warrant the legal enforceability or correctness of any such contract or agreement or invoice or similar.
You agree to
engage your own solicitor or lawyer to draft agreements or contracts suitable to your needs and locality. You accept that in no
circumstance will Tenset Technologies Ltd have any liability with respect to any use of any sale agreement or contract or invoice
or similar generated by Breeders Assistant."
See:
Records
15. Cat
Mating Certificates
See Also:
See:
See:
Kinship And Population Analysis: Mate Selection - Overview
29.5. Mate Selection,
See Also:
18.1. Using
Inbreeding Coefficients
About Inbreeding
The degree of inbreeding depends on how many common ancestors there are, and how close they are in the pedigree.
E.g. a
common grandparent has a much larger impact on the degree of inbreeding than does a common great-great-grandparent.
Inbreeding is computed using a formula known as Wright's Coefficient of Inbreeding.
The inbreeding coefficient is expressed as a
percentage.
The symbol COI or F is sometimes used for this coefficient.
F is the generally accepted symbol for inbreeding within
scientific literature.
In Breeders Assistant inbreeding can be computed for any record that has parentage recorded i.e. a sire and dam - which includes
both mating and trial mating records in addition to cats.
Unless specified otherwise all the features described in this section apply
equally well to matings and trial matings.
Breeders Assistant can compute the inbreeding associated with a record when required.
It can be included in any form associated
with cats, matings or trial matings - including all pedigrees.
It is also possible to tabulate the inbreeding coefficients in the record
list in the main window and to include it when exporting data.
If you have the Extended Edition of Breeders Assistant it is also possible to use its bulk computation of inbreeding in mate selection
and population analysis tools.
E.g. it is possible to prioritize prospective matings according to the extent of inbreeding that would
arise in any potential offspring from a mating.
Breeders Assistant does not include a field for storing the inbreeding coefficient.
There is no place in the Cat Details window to
enter it.
This is because whenever it is needed for an individual record it is re-computed if necessary (i.e., if there have been any
potential changes in the relevant ancestry).
Breeders Assistant can also compute the rate of inbreeding and loss of heterozygosity (LOH) over a given number of ancestor
generations.
The relationship coefficient (RC) can also be calculated, for inclusion in mating certificates, litter pedigrees and trial
mating pedigrees.
See:
Mating Certificates
29.5. Mate Selection, Kinship And Population Analysis: Mate Selection - Overview
See Also:
Include In Pedigrees
Most pedigree layouts can
include the inbreeding coefficient.
Many of the standard pedigree forms have the inbreeding coefficient
enabled by default - to see such a pedigree click the Display button, select Pedigree from the popup menu then choose any layout
that has 'Inbreeding' as part of its name.
The coefficient is included together with other details of the subject cat, normally in the
details box in the pedigree heading.
Pedigree layouts that do not already include the inbreeding coefficient can be customized to include it by altering the details box
properties.
Normally the inbreeding coefficient is only included for the subject cat, but it can also be included for the ancestors - by customizing
the per-generation settings within the tabular ancestors box.
Examples that show how to change the cat's details and ancestors table are included in the "Pedigree Layouts" Tutorial. To access
this - and other tutorials - select Tutorials from the Help menu within Breeders Assistant.
To include the inbreeding coefficient in any custom form associated with cat, mating or trial mating forms - e.g. in a letter form - all
that is needed is to include the <InbreedingCoefficient> field code.
For further details of this field code see section 4.7 "Fields
And Field Codes Reference: Cat Records" of the Help Reference.
Export To Text/CSV
can be included when exporting to a text/CSV file either by selecting it as one of the output fields or, if
The inbreeding coefficient
using a custom text expansion, by including the <InbreedingCoefficient> field code.
If you have the Extended Edition it can also
be exported as part of the 'Key Metrics' analysis - see 29.9. Mate Selection, Kinship And Population Analysis: Population Analysis -
Overview.
Printed Reports
tool can include the inbreeding coefficient as a column within a report layout.
The record reporting
Analyse Inbreeding
An 'inbreeding analyis'
form can be displayed that shows the inbreeding coefficient along with related information such as the depth
at which the furthest ancestor was found, the number of generations of ancestors that were full, the total number of ancestors
found, the total number of unique ancestors and the total number of ancestors common to both sides of the pedigree - and each
calculated with a range of ancestor depths.
This can show how the inbreeding increases as the pedigree is analysed to greater
depths.
To access this click the Display button then choose an option from the Inbreeding Analysis menu.
With the Professional and Extended Editions the ancestors can be color coded in a pedigree to show their inbreeding.
For further information see section 19 "Ancestor Highlighting" (p.47) of the 'First Steps' Tutorial. To access this - and other tutorials
- select Tutorials from the Help menu within Breeders Assistant.
See:
Inbreeding And Related Metrics
29.9. Mate Selection, Kinship And Population Analysis: Population Analysis - Overview
See Also:
'First Steps'
Tutorial - 19 Ancestor Highlighting (p.47)
Records
15. Cat
18. Records And
Inbreeding
Number of Generations
This is the number of generations of ancestors to be considered when computing the inbreeding.
Precision
of decimal places to display for the inbreeding coefficient.
If you have the Extended Edition this also affects the
The number
precision with with all other coefficients are shown when using the mate selection and population analysis tools, such as kinship and
pedigree completeness coefficients.
In addition to choosing the number of generations of ancestors to be considered in the inbreeding calculation, it is possible control
the treatment of ancestors 'beyond' the pedigree but which are visible to the calculation e.g. due to multiple occurrences of the
same ancestor in different generations of the pedigree.
This is perhaps best introduced with an example.
Consider the calculation of Wright's inbreeding coefficient to 4 generations for the following pedigree of a hypothetical animal X:
G G G G
---+---1--+---2--+---3--+---4----
+-- Fred
+-- George
+-- JOE
| | +-- Fred
| +-- Mary
+-- Peter
| | +-- George...S=Fred
| | +-- JOE
| | | +-- Mary...S=Fred
| | +-- Albert
| +-- Alice
| +-- Ben
| | +-- JOE...George,Fred,Mary,Fred
| +-- LIZ
+-- X
| +-- Fred
| +-- George
| +-- JOE
| | | +-- Fred
| | +-- Mary
| +-- Sue
| | +-- Tina
| | | +-- JOE...George,Fred,Mary,Fred
| | +-- LIZ
+-- Rose
Note that:
1. Ancestors shown in red are occurrences of ancestors that are only known to the inbreeding calculation if it is
permitted to consider the parents of the last generation.
2. Ancestors shown in blue represent ancestors beyond 4G that are also known to the inbreeding calculation because
they also occur in earlier generations in the same pedigree.
3. X has five common ancestors - ancestors occurring on both sides of the pedigree that is.
These are Fred(G4+5),
George(G3+4+5), JOE(G2+3+4), LIZ(G4), and Mary(G3+4+5).
4. JOE is himself inbred 12.5% because JOE shares a common Grandsire, Fred.
5. Fred, George and Mary only occur in the pedigree of X as ancestors of JOE.
6. The only ancestors of X that are common ancestors of X are JOE and LIZ - i.e. ancestors that occur in both the
paternal and maternal sides of X's pedigree.
They are highlighted in the pedigree by being shown in UPPER CASE.
To calculate the inbreeding coefficient to 4 generations, Breeders Assistant examines the ancestors that comprise the parents,
grandparents, great-grandparents, and the great-great-grandparents in the pedigree.
In doing so, there are various choices the
software could make:
1. Should it take into account its knowledge of the parents of the individuals in the last generation?
E.g., in the dam side
of X's pedigree LIZ occurs in the 4th generation, and Breeders Assistant has available to it the knowledge that LIZ's
sire is JOE, who also occurs on the sire side of X's pedigree.
If your reason for supplying a generation depth limit (4)
to the COI calculation is to prevent it taking too long, perhaps you would like it to ignore the inbreeding due to this.
Alternatively if you are looking for the software to compute a coefficient as close to the 'theoretical' value (i.e., the
value that results if all known ancestors are considered), whilst keeping a sensible cap on the amount of computer
time used in the calculations, perhaps you would like this to be included.
2. When considering a common ancestor that is itself inbred, how much of that common ancestor's inbreeding should it
consider?
E.g JOE is a paternal grandsire and his own inbreeding (due to Fred) is 'visible' within the 4 generation
pedigree of X but only at his appearance as paternal grand-sire.
However, when JOE appears as a great-grandparent
on the maternal side of X's pedigree, JOE's own inbreeding is not visible within the 4 generation pedigree of X.
So, in
considering the contribution to X's inbreeding coefficient caused by the path JOE-Peter-X-Rose-Sue-JOE, should, or
should not, JOE's own inbreeding be included in the calculation?
3. Likewise, consider the path JOE-Albert-Alice-Peter-X-Rose-Sue-JOE.
This involves JOE appearing in generation 4 on
the paternal side, and generation 3 on the maternal side.
It is only due to JOE's other appearance in the 4G pedigree
(as paternal grand-sire) that the software knows that JOE is 12.5% inbred.
However, is it 'right' to include this when
computing the contribution to X's inbreeding due to the path JOE-Albert-Alice-Peter-X-Rose-Sue-JOE?
After all, that
path would still exist in X's pedigree even if the software did not know that JOE was Peter's sire .. and hence did not
know JOE was inbred.
Issues like this arise because of additional information being available to the software, and because common ancestors can occur in
different generations of the pedigree.
Breeders Assistant provides the means to control the behaviour of the inbreeding calculation in these situations by selecting an
'Optimization' preference setting.
Four settings are available:
Strict with Minimal Common Ancestor Inbreeding
Strict with Maximum Common Ancestor Inbreeding
Relaxed with Maximum COI
Relaxed with Maximum Speed
TIP:
One way to see the effects of the different optimization settings is to select Display|Inbreeding Analysis and then choose
one of the options labeled Optimization Comparison....
This displays a table showing the differences in coefficient values for
each of the optimization settings, for varying #generations of ancestors.
The Strict options prevent the software from incorporating inbreeding that can only be deduced by 'seeing' ancestors beyond the
generation limit of the calculation.
E.g., parents of the last generation ancestors are specifically ignored.
Strict means that the
software is to strictly observe the ancestor generation limit imposed on the calculation: it is not to step beyond the last generation
even though that information may be available.
There are two variations possible with the 'Strict' setting: Minimal or Maximum common ancestor inbreeding.
If Strict with
Minimal Common Ancestor Inbreeding is chosen, only the inbreeding of a common ancestor that is visible within the pedigree at
both the sire and dam side occurrences, on a path by path basis, is included.
In the above example, this would cause JOE's
inbreeding to be ignored in all paths contributing to X's inbreeding coefficient, because JOE's own inbreeding is only visible in the
sire side of X's pedigree to 4 generations.
If Strict with Maximum Common Ancestor Inbreeding is chosen, the software uses
the maximum inbreeding of the common ancestor as can be deduced by examining its sire and dam side occurrences, again on a
path by path basis.
E.g. in the above example, considering the path JOE-Peter-X-Rose-Sue-JOE, the 12.5% inbreeding of JOE is
included because it is visible on the sire side of this path.
But, in the path JOE-Albert-Alice-Peter-X-Rose-Sue-JOE it is not included
because neither occurrence of JOE in this path lets us 'see' the common ancestors of JOE within the 4 generation pedigree of X.
As a consequence of how the inbreeding computations are carried out, both of the 'Strict' options can be significantly slower to
perform than either of the 'Relaxed' options.
For this reason they are limited to at most 16 generations of ancestors.
The 'Relaxed'
options are very much faster when computing inbreeding to any significant depth of ancestors and should usually be preferred.
There are 2 variations possible with the 'Relaxed' setting: either 'Maximal COI' or 'Maximum Speed'.
Choosing Relaxed with
Maximal COI will cause the software to include all possible common ancestors that can be deduced from the pedigree, subject only
to the generation limit.
Specifically, the software will include its knowledge of the parents of ancestors that only occur in the last
generation.
E.g. in the pedigree of X, LIZ occurs in the 4th generation on both paternal and maternal sides.
But Breeders Assistant
can also take into account its knowledge that LIZ's sire is JOE, and JOE occurs elsewhere in both sides of the pedigree.
This lets it
include additional inbreeding due to JOE that it might otherwise ignore.
If you select 'Relaxed with Maximal Speed', Breeders
Assistant will try to compute the inbreeding coefficient as fast as possible.
Specifically, it will ignore its knowledge of the parents of
ancestors that only occur in the last generation.
The following table shows which common ancestor paths are included in computing the inbreeding of X to 4 generations for each of
the different optimization settings.
('Fa' is the inbreeding due to the identified common ancestor path that is included in the calculation; 'Contribution to F' is the
contribution to the inbreeding of X due to this common ancestor)
29.2. Mate Selection, Kinship And Population Analysis: Population Genetics Concepts And Terminology
29.5. Mate Selection, Kinship And Population Analysis: Mate Selection - Overview
See Also:
Breeders Assistant can detect such errors at the same time as creating the inbreeding analyis reports.
E.g. if Arripay Bigfoot
appeared as an ancestor 18 generations back in some other cat's pedigree, the inbreeding analysis report for this cat would contain
the following:
Arripay Bigfoot
I.e., this is reporting that Arripay Bigfoot is claimed to be descended from itself - with the other ancestors that make up the 'loop'
given.
The G18 in the report states that this happened 18 generations back.
This information can be used to help track down errors
in your data.
When self-parenting errors are detected the inbreeding/relationship coefficient cannot be calculated.
Instead of seeing the
coefficient percentage a code such as !G18 is displayed instead - this states that the calculation failed because of an error 18
generations back.
In most cases such errors are caused by circularities.
It is also possible to detect self-parenting errors across the whole database using the database inconsistency checking facility.
See:
8.10.
Cat Database Files: Database Inconsistency Checking
The inbreeding field code <InbreedingCoefficient> also accepts a number of parameters through which it is possible to retrieve
other associated values, such as the generation # of the deepest ancestor found, the number of common ancestors, etc.
For further
information see section 4.7 "Fields And Field Codes Reference: Cat Records" of the Help Reference.
See:
Help Reference - 4.7 Fields And Field Codes Reference: Cat Records
18.7. Records And Inbreeding: Bulk Computation Of Inbreeding With The Extended Edition
The Extended Edition of Breeders Assistant can include inbreeding coefficients within its population genetics analyses, e.g. the Key
Metrics analysis.
This is an alternative (and somewhat faster) way to compute inbreeding and other metrics such as the pedigree
completeness index.
See 29.3. Mate Selection, Kinship And Population Analysis: Inbreeding And Related Metrics.
See:
Inbreeding And Related Metrics
29.3. Mate Selection, Kinship And Population Analysis:
See Also:
19. Ancestors
Ancestors are stored in Breeders Assistant as sire/dam links in cat records.
Contents
19.7. Mate Selection, Kinship And Population Analyses In The Extended Edition
See:
Records
15. Cat
See Also:
See:
Help Reference - A.54 Procedures By Subject: Main Window and Data Entry
See:
See:
'First Steps'
Tutorial - 19 Ancestor Highlighting (p.47)
See:
To set the #generations used for inbreeding calculations: select Configure|Preferences ( Ctrl+E), move to the
Inbreeding tab,
then enter the required number in the box marked No. of generations to use when computing
inbreeding coefficient.
First - The closest generation in which this ancestor occurred.
Where - The number of times the given ancestor was found at each generation on either side of the pedigree.
E.g.
S5:3, D4 means that it occurred 3 times in the 5th generation in the sire side, and once in the 4th generation on the
dam side.
Breed - The short breed description of this ancestor.
Genotype - The genotype of this ancestor, created by concatenating together all genotype fields (as given on the
Genotype tab of the Cat Details window).
Requires Professional Edition (or higher).
See:
19.7. Ancestors: Mate Selection, Kinship And Population Analyses In The Extended Edition
Ancestry analysis plays a fundamental role in the mate selection, kinship and population analysis tools of the Extended Edition of
Breeders Assistant.
See 29. Mate Selection, Kinship And Population Analysis.
See:
Population Genetics Concepts And Terminology
See Also:
Mate Selection
20. Descendants
Breeders Assistant provides a variety of tools concerning descendants.
With any of the features relating to descendants misleading results can occur if the sex of a cat is not recorded correctly. Whenever
a cat is added to the database it is important to make sure the sex is correct.
For this reason Breeders Assistant prompts if you
forget to enter the sex.
Any cat that does not have its sex set is excluded from the mate selection, kinship and population analysis
tools of the Extended Edition.
See 29. Mate Selection, Kinship And Population Analysis.
There are also database inconsistency checks available to search the whole database for cats where the sex is either not recorded,
or is inconsistent with sire/dam links (e.g. cats recorded as being male yet appearing as the dam of other cats).
See:
8.10.
Cat Database Files: Database Inconsistency Checking
Population Genetics Concepts And Terminology
See Also:
See:
See Also:
To see the standard analyis forms switch to cat records then click Display|Descendants.
The table contains the following columns.
The column on which the table is sorted is always shown leftmost.
Closest Gen - The closest generation where this descendant was found.
Name - The descendant's name, including title.
Sex - A single letter given the sex of this descendant.
Date of Birth - The date of birth of this descendant.
Count - The number of times the descendant could be located in the given number of generations.
Inbreed% - The coefficient of inbreeding of the descendant, computed using the system default #generations for
inbreeding computations.
To set the #generations used for inbreeding calculations: select Configure|Preferences ( Ctrl+E), move to the
Inbreeding tab,
then enter the required number in the box marked No. of generations to use when computing
inbreeding coefficient.
Breed - The short breed description of this descendant.
Genotype - The genotype of this descendant, created by concatenating together all genotype fields (as given on the
Genotype tab of the Cat Details window).
Requires Professional Edition (or higher).
See:
To see the standard reverse pedigrees switch to cat records then click Display|Descendants|Reverse Pedigrees.
E.g. Non-deduplicated reverse pedigree:
| +-- GR CH Arripay Dark Crystal F, 01/02/1997, 1.6% Inbreed%, Seal Pt. Sia.
| +-- GR CH Arripay Dark Crystal F, 01/02/1997, 1.6% Inbreed%, Seal Pt. Sia.
+-- GR CH Arripay Dark Crystal F, 01/02/1997, 1.6% Inbreed%, Seal Pt. Sia.
| +-- GR CH Arripay Dark Crystal F, 01/02/1997, 1.6% Inbreed%, Seal Pt. Sia.
| +-- Arripay Lilac Lady F*, 18.8% Inbreed%, Choc. Pt. Sia.
Notice that Arripay Brown Beauty and Arripay Sardar have been deduplicated.
See:
Records
15. Cat
Report Layouts
Each record type (cats, contacts, etc.) has a set of available report layouts.
A report layout defines the columns that are to be printed, their width on the printed page, and whether or not the report is to be
'grouped'.
When a database is created a set of sample report layouts is provided for each record type.
E.g. cat records have a 'Breeder &
Owner' report layout that includes, in addition to the cat's name and sex, the names of the breeder and owner and selected other
fields - along with many other standard layouts.
To view/update the available report layouts select Configure|Report Layouts.
Grouped Reports
A 'grouped report' is
one where records containing the same text for a given column are printed together.
E.g. (1) a report of cats grouped by cause of death would list the cats that have died of each different cause separately.
E.g. (2) a report of accounting reports grouped by category means that the report would list the records for each different
income/expense category in separate groups.
Contents
Layouts
21.1. Report
See:
See Also:
Gaps - The width and height of the gaps between rows and columns.
Grid lines - Whether or not to print grid lines.
See:
Printing To PDF
22.3. Printer Configuration:
To group the report by a given field, Breeders Assistant builds an alphabetically sorted list of all the different values seen in that field
for the defined set of records.
Then, for each different group value, it locates all the records with that value and prints them as a
group, preserving the same record ordering as would have been used had the report been ungrouped.
If multiple group fields are
given, this process is repeated within each subset of records.
The ordering of records within any table of a grouped report will be the
same as the order of those records within the whole set.
See:
Margins
to adjust the page margins of a pedigree, choose Printer/Paper Properties from the popup menu.
If you need
This is demonstrated in greater detail in section 5 "Adjusting The Page Margins" (p.11) of the 'Pedigree Layouts' Tutorial. To access
this - and other tutorials - select Tutorials from the Help menu within Breeders Assistant.
Printing To PDF
If you have a 'print
to PDF' facility - as is standard with Windows 10 and Windows 11 - it is possible to set up Breeders Assistant to
print to PDF files.
Portrait Or Landscape
To change the orientation
(portrait/landscape) of a pedigree, form or report
switch the form to use a different printer/paper
configuration: right-click over the form in the main window, choose Form Properties
from the popup menu, then select either
'Default-Landscape' or 'Default-Portrait' from the Printer/Paper pulldown menu as appropriate.
Unless you have other printer configuration requirements, it is probably not necessary to read the remainder of this section of the
User Guide as the default settings should be sufficient.
Fundamental to how such customizations are achieved in Breeders Assistant is the concept of printer/paper configurations.
Contents
22.1. About
Printer/Paper Configurations
See:
See Also:
It might be desirable to use manual paper feed when printing with a particular pedigree form.
E.g. in order to use a
special high quality paper.
This is just a matter of creating a custom printer/paper configuration that has printer-specific
settings set to use manual tray loading, and then linking that printer/paper configuration to the relevant pedigree form.
Whenever the form is printed, the printer will automatically use manual feed.
See:
Report Layouts
21.1. Printed Reports:
NOTE:
The paper size used by the 'Default-Landscape' and 'Default-Portrait' configurations should be the standard settings as
reported by the default system printer driver.
This is typically A4 in Europe; Letter size in North America.
If this is incorrect - e.g.
you're in Europe but your system default printer is set to print on US Letter sized paper, use the Windows Settings app to alter the
properties of the printer.
See:
other tutorials - select Tutorials from the Help menu within Breeders Assistant.
From this point on whenever any of the standard document forms with landscape orientation are 'printed', they will be saved as PDF
files rather than actually printed to a physical printer device.
To achieve this, it is necessary to set up a new 'Printer/Paper Configuration' for PDF printing, and then associate that with any
document (such as a pedigree layout) that is to be saved as PDF when it is 'printed'.
To create the new printer/paper configuration:
1. On the Configure menu select Printer/Paper Configurations.
2. Select 'Default-Landscape' from the list, then click the Duplicate Configuration button.
3. When asked for a new configuration name enter PDF-Landscape, then click OK.
4. At the next window, check the Specific Printer option, then find and select Microsoft Print to PDF from the list of
available printers, then click OK.
5. When asked if you want to calibrate the printer click No.
6. You'll be returned to the Configure Printer/Paper Configurations window.
7. Click OK to return to the main window.
What the above steps have done is to create a new printer/paper configuration for use when creating PDF documents with landscape
orientation, such as pedigrees.
A similar technique can be used to create a configuration for use when creating portrait PDF's - just
start by duplicating the 'Default-Portrait' standard configuration instead.
However, in order to actually make use of the new PDF configuration it is necessary to associate it with any form or pedigree layout
that is to be saved to PDF.
To do this requires changing the properties of each such form to use the new configuration.
E.g. to change a pedigree layout to print to PDF:
1. First, display the chosen pedigree layout in the main window - use the Display button to select the layout style.
2. Right-click over the pedigree in the main window and choose Form Properties from the popup menu.
The Form
Properties window is displayed.
3. Click in the Printer/Paper list at the top and select the name you used (above) when creating the PDF print
configuration, e.g. 'PDF-Landscape'.
4. Click OK.
From this point on, when this specific pedigree layout is 'printed', it will be saved as a PDF instead.
It is necessary to repeat the above steps with any form that is to be saved to PDF rather than actually printed.
The advantage
though of this technique is that by creating a separate printer/paper configuration specifically for PDF printing it is possible to retain
See Also:
'First Steps'
Tutorial - 11 Creating A PDF Pedigree (p.24)
Printer Drivers
Each different printer has different capabilities - e.g. supported paper sizes - and understands different instructions.
Since there are many different printers available on the market, it is unrealistic for Windows, or any application software for that
matter, to support all available printers directly.
Instead, a piece of system software called a printer driver is used.
This is software that is installed when your printer is set up.
It is
normally supplied along with the printer, though Windows includes drivers for many well known printers.
Installation of the printer
driver normally happens automatically as part of the process of adding the printer to the computer or network.
However sometimes
to get the latest versions of driver software it may be necessary to download from the printer manufacturer support website.
When a printer driver is installed, it is associated with the port through which the printer has been physically connected.
This is why a printer is often described in terms of "Printer abc on port xyz:". E.g. "HP LaserJet 6P/6MP on port LPT1:".
Most of the time when there is a reference to a 'printer' within this product and its documentation what is actually meant is a printer
driver plus port, rather than the physical printer itself.
Margins
most printers are not capable of printing on the entire sheet of paper.
There are usually parts of the sheet that the
In general,
printer simply cannot physically print on.
An application, such as Breeders Assistant, can determine from Windows how large these
unprintable parts should be.
Unfortunately, this is sometimes an inaccurate value, because there is a natural variance between
different actual printers, the exact positioning of paper in the printer, printer drivers, and so on.
Breeders Assistant includes a facility called 'margin calibration' that can be used to determine exactly how large the unprintable
parts are.
This helps in achieving accurate margin placement, particularly when printing labels.
See 22.7. Margin Calibration.
Application Printing
When an application prints, what it does is it accesses the printer by asking Windows to connect it to the printer driver and port,
given the printer driver name and the port name.
If an application wants to print to the system default printer, it can first enquire
from Windows as to what the default printer is.
The application can either use the system-wide printer device settings for the printer, or it can supply its own device settings.
Some Windows applications can only print to the system default printer, using the default device settings for that printer.
This is
suitable for applications that do not have demanding printing needs.
Breeders Assistant on the other hand provides some advanced print customization and can be configured to use different printers
with varying device settings.
Even though this provides a lot of flexibility should it be needed, the default settings will still use the
system default printer for most printing operations, in either portrait or landscape orientation as appropriate.
See:
22.7.
Printer Configuration: Margin Calibration
See:
In Printed Reports
Each report layout includes the name of the printer/paper configuration it uses.
To change this, select Configure|Report Layouts
and then update the relevant report layout.
E.g. to create a report layout that uses a large format printer (e.g. US ANSI 'B' paper), create a new printer/paper configuration
configured appropriately and then associate it with the report layout.
Obviously a suitable printer is needed to do this.
Unlike document forms, text forms do not include the name of a printer/paper configuration as one of their properties.
This is
because the main reason for using text forms is not usually to print them - they are for generating text for transfer into other
applications.
When printing a text form, the Print Text Form window has an option to select the printer/paper configuration.
Normally this is
'Default-Portrait' but can be changed.
E.g. to print a text form in landscape use 'Default-Landscape'.
See:
This is a procedure Breeders Assistant uses to determine the precise sizes of the unprintable margins for a given printer/paper
configuration.
This may be necessary in some cases to achieve accurate margin placement.
Margin calibration involves printing a test page with blocks of color in the corners of the page, as close as possible to the edge of the
paper.
The distance between these blocks and the edges of the paper can then be measured (manually, by you with a ruler) and
entered into the software.
Once this is complete, the margin sizes as set in the printer/paper configuration should more accurately
reflect the physically printed result.
What this actually does is give the software a way to compare the size of the 'unprintable' margins as seen on a real printout - that
part of the paper that cannot be printed on - with the extent of the 'unprintable margins' as reported by the printer driver software.
It is our experience that these are not always the same, even though theoretically they should be.
For further information see 22.4.
Windows Printing Primer.
Whenever a printer/paper configuration is customized - such as when the print margins or device settings are changed - the
software will prompt to calibrate the margins.
In most situations it is not needed.
However it is particularly important to carry out a
margin calibration when setting up label printing. See 22.8. Label Printing.
See:
See Also:
See:
Letters, Envelopes, Address Labels and Mailing Lists
14.4. Contact Records:
See Also:
NOTE:
Support for financial accounting in Breeders Assistant is only intended for the hobbyist who wishes to track the financial side of
his/her hobby in a limited way.
It is not designed for the financial tracking, recording or reporting necessary when running a
business or any other non-hobby activity or where there is a need to account for tax e.g. to taxation authorities in your
jurisdiction. In these situations you are recommended to use a separate, dedicated and appropriate accounting software package.
Categorized Reports
The accounting records enable production of categorized reports of income and expenditure in various ways - e.g. on a cat by cat
basis.
The accounting support has also been tied in with other procedures within Breeders Assistant that involve financial transactions.
E.g.
when adding a vet record that involves a vet fee the software asks if an accounting record should be added to store the fee.
Tax Tracking
There is a very
limited form of tax tracking.
This may be useful if you wish to track tax on sales and purchases, and is limited to
situations where tax is charged at the same rate on the entire net value of a transaction.
If you are resident in the UK or European Union this lets you track amounts of money ex-VAT and to produce simple VAT invoices.
Breeders Assistant does not do VAT or tax returns or anything else concerning VAT or taxation.
Each accounting record has links to contact and cat records in the following ways:
Other Party - A link to a contact record for the other party to the transaction - the party to whom money has been paid
if it is an expense transaction, or the party who has paid you in the case of an income transaction.
Cat Record - A link to a cat record with which the transaction is associated.
E.g. an accounting record for stud fee
income would normally be linked to the record for the sire; this would allow you as stud owner to subsequently print a
report of stud fee income categorized on a stud by stud basis.
User - A link to a contact record for the 'user'.
All accounting transactions are assumed to be between a licensed user of
the software, and a third party.
If you have a single user license for Breeders Assistant, the 'user' will simply be you (i.e., a link to the contact record
that represents you).
With a multiuser license, the 'user' field will be one of the contact records for the licensed users.
Breeders Assistant asks if you want to automatically add an accounting record in certain situations, such as:
When you buy or sell a kitten/cat.
When you enter a vet record in which a vet fee is given.
When you enter a mating record in which a mating fee is charged.
When you enter a show record in which an entry fee or prize money is given.
For these transactions it is usually both easier and better to let Breeders Assistant create the records automatically in this way
because there is less likelihood you will forget to add them, and they will be added in a consistent manner.
The opportunity is always
given to manually alter each record prior it being added.
See:
See Also:
you do not charge tax but you want to track tax separately to the non-tax component of transactions
If you are resident in the UK or European Union this can be used for limited VAT tracking and printing simple VAT invoices.
As already stated, the taxation support in Breeders Assistant is limited when compared to that of dedicated accounts software.
It is
only intended for use by a hobbyist.
If you run a business where you must account for taxes you are strongly advised to use a
dedicated accounts package rather than the simple accounting facility within Breeders Assistant.
Breeders Assistant's accounts operate either with taxation enabled or disabled.
By default it is disabled; if you use taxation you
should enable it, preferably before you've added any accounting records.
To do this select Configure|Accounts|Setup.
Accounting records contain six separate fields for recording the amounts involved in a transaction:
gross expense
net expense
tax expense
gross income
net income
tax income
Each accounting record includes the tax code and rate that is applied to that transaction.
NOTE: Breeders Assistant does not support
the application of separate tax codes/rates to different parts of a single transaction.
The only alternative would be to enter separate
transactions for each part of a transaction that has a different tax treatment.
Tax Codes
Income Types
maintains a list of different income categories.
E.g. Stud Fee Income, Interest.
These can be extended using
Breeders Assistant
Configure|Accounts|Income Types.
When adding or updating an accounting record for income received an income type should be assigned to it.
This can be
subsequently be used to produce categorized income/expenditure reports.
Expense Types
Likewise a list of different expense categories is maintained.
E.g. Vet Fee, Kitten/Cat Purchase.
These can be extended using
Configure|Accounts|Expense Types.
When adding or updating an accounting record for an expense an expense type should be assigned.
This can be subsequently be
used when producing categorized income/expenditure reports.
See:
Tax
23.1. Accounting Records:
Reminders
Appointment
reminders provide a means to be reminded about specific appointments/tasks before they occur.
A reminder can be set
to either be at a specific date & time, or to occur a given number of days/hours/minutes before the appointment/task.
Reminder messages are only displayed within the software when the database is open and visible.
If the computer is on, but
Breeders Assistant is closed, reminders will not display.
Whenever an Breeders Assistant database is opened, any appointment
reminders that 'expired' whilst the software was closed are displayed immediately.
Completing Tasks
Appointment/task records have a 'completion' marker that can be helpful if they are being used to record tasks/chores.
Tasks that are marked as uncompleted are displayed in the record list in a different color.
Normally this is blue.
This color is a
preference setting; to change it select Configure|Preferences ( Ctrl+E) and use the User Interface tab.
To mark an appointment/task as completed, select it in the record list, right-click and select
Mark Appointment/Task As Complete.
Appointment/task records include indexes (views) that display only the completed/uncompleted appointments:
Uncompleted appointments/tasks, ordered by date+time
Completed appointments/tasks, ordered by date+time
See:
See Also:
A vaccination record may contain details of up to eight separate vaccinations that have been given at the same time.
Vaccination Types
Breeders Assistant maintains a list of types of vaccination - names of diseases against which vaccinations are available.
When a vaccination record is added or updated, the types of vaccination given can be selected.
To update the list of vaccination types use Configure|Vaccination Types.
See:
See Also:
The Show Record Details window can operate in either a 'normal' or 'advanced' mode.
In the advanced mode many more fields
are available.
To switch between normal and advanced mode, use Configure|Preferences ( Ctrl+E), move to the User
Interface tab and change the 'Use advanced show records' option.
Breeders Assistant includes a facility to help detect inconsistencies between show records - e.g. that all records relating to a given
show have certain details (fields) that are the same throughout.
See 8.10. Cat Database Files: Database Inconsistency Checking.
Kinds of Shows
Show records contain a Kind of Show field that should be used to record the 'type' of show - such as National, All Breed, etc.
To update/extend the list of standard choices for this field use Configure|Show Record Lists|Kinds of Show.
Show Statuses
Show records contain a Status field that should be used to record the 'significance' of the show - such as Championship, Exempt,
etc.
To update/extend the list of standard choices for this field use Configure|Show Record Lists|Show Statuses.
Each show record includes a Class Type field that identifies the type of class - e.g. Open or Debutante.
To update/extend the list of standard choices for this field use Configure|Show Record Lists|Class Types.
8.10.
Cat Database Files: Database Inconsistency Checking
Prerequisite Knowledge
Please note that:
1. To effectively use these features you need to be comfortable with basic genetic concepts.
You should understand what
is meant by the following terms: gene, genotype, phenotype, allele, locus, chromosome, sex linkage, recessive
genes, dominant genes, and polygenic versus discrete inheritance.
If you are unfamiliar with these terms or concepts
please consult any standard genetics textbook before proceeding.
2. In order for the genotype fields to be accessible within the Cat Details window it is necessary to have 'advanced cat
records' enabled (select Configure|Preferences ( Ctrl+E), move to the User Interface tab, check the 'Use
advanced cat records' option and click OK).
3. This section of the User Guide often uses examples drawn from the genetics of cats and dogs.
However the features
described can be applied whatever type of animal you're using Breeders Assistant for.
It's just that the authors are
more familiar with cats and dogs.
If you are familiar with feline & canine color genetics you will also realize that we
have ignored many genes in our examples; this is just to simplify the text.
Gene Configurations
The Mendelian Genetics features require that a set of genetic rules have been set up.
This set of rules is termed a 'gene
configuration'.
The gene configuration defines the gene and allele symbols, and related information such as how these combine to
form different phenotypes within offspring.
A gene configuration is used by Breeders Assistant to 'understand' genotypes entered into cat records.
There are two types of gene configuration: user defined gene configurations which are configurations where you set up the genetic
rules, and, with some variations of Breeders Assistant, inbuilt gene configurations supplied with the product.
Inbuilt gene configurations are fixed in the product and cannot be directly customized (though some settings can be altered - see
28.12. Adjusting An Inbuilt Configuration).
A user defined gene configuration is stored as a text file using a special syntax, further details of which can be found in section 7
"Mendelian Genetics Configuration Reference" (p.113) of the Help Reference.
It is possible to purchase user definable (customizable) versions of the inbuilt gene configurations.
E.g. to develop a gene
configuration for a new breed one way to proceed is to start with a user definable configuration for a known (related) breed and
then modify it.
For further details of the availability of equivalent user definable gene configurations for the inbuilt configurations
contact Tenset.
A skeleton (empty) user defined gene configuration is however included that outlines the basic structure of a typical
user defined gene configuration file.
Inbuilt gene configurations for over 35 of the most the popular breeds, with coverage of over 30 congenital diseases for which the
mode of inheritance is known, are included with the product.
A 'generic' inbuilt gene configuration is also supplied which uses breed-
independent nomenclature for the expressed colors.
For current details of available gene configurations refer to the Tenset website www.tenset.co.uk.
To use one of the standard (inbuilt) gene configurations, use Configure|Mendelian Genetics.
The first time this is used the
product will display a list of available configurations from which a selection can be made, if appropriate.
If you have previously
selected a configuration but now wish to change it, click the Choose A Standard Configuration button to redisplay the list.
If your breed is not included, select a different breed that is 'close' to yours in terms of the genes and terminology used for colors
etc. if possible.
If that is not appropriate, there is a 'generic' gene configuration that uses breed-neutral terms for the colors etc.
This is described in detail in section 7 "Mendelian Genetics Configuration Reference" (p.113) of the Help Reference.
Contents
28.2. Mendelian
Genetics: Genotype Fields
29.5. Mate Selection, Kinship And Population Analysis: Mate Selection - Overview
See Also:
See:
16.3.
Mating Records: Mating Certificates
Mating Predictions
Entering Genotypes
Genotypes can be entered by simply keying them in, e.g. "AyAy" or, depending on the gene configuration, by clicking the Select
Genotype button.
If available, this displays the Select Genotype window.
This is effectively a 'user friendly' way of entering the
genotypes into these boxes with pulldown menus of known allele combinations.
Note that the appearance of the Select Genotype window is determined entirely by the gene configuration.
If you develop a
custom user defined gene configuration you can determine the layout of the Select Genotype window.
NOTE:
It doesn't actually matter which genes you choose to place in each genotype field. Internally, Breeders Assistant simply
concatenates all these fields when the genotype of cat is needed.
The only reason why there are separate fields is to allow you to
store genotypes that affect different types of trait separately.
See:
Records
15. Cat
In this example the gene model features the B, C, D and O genes, and the model has an 'assumed genotype' set for the C gene.
In
the domestic cat, the C gene has alleles that differ between breeds such as Siamese, Burmese and Tonkinese.
But because most
Siamese breeders only breed Siamese, their cats are almost always going to have two copies of the "cs" allele (Siamese coloration)
and so the gene model in this example assumes this
in order to save the user from having to enter "cscs" for every cat.
See:
Genotype Fields
28.2. Mendelian Genetics:
The following shows an example of a computed phenotype - in this case in the Select Genotype window.
There are several variants of a computed phenotype, depending on whether or not carried or expressed traits are included in the
generated description.
It is possible to have computed phenotypes that include (a) both the expressed and carried traits, or (b) include just the expressed
traits, or (c) include just the carried traits.
The first is most often used.
See:
The first 3 elements here state the alleles for discrete genes.
The last element, Hd=8, gives a numeric value for a polygenic trait with
symbol Hd.
Discrete Genes
A discrete gene value is normally a pair of alleles; in the case of a sex linked gene on the X chromosome there should be one or 2
alleles depending on the sex of the cat concerned (1 for males, 2 for females; vice versa for birds).
A dash ('-') can also be used as
a wildcard.
E.g.:
B- Dd O
...because the two alleles for the D gene have been entered with a space between them (between the D and the d).
This is because the alleles are carried on different chromosomes, and they are therefore inherited completely independently of each
other (Mendel's law of independent assortment).
However when genes are linked their alleles are carried on the same chromosomes.
It then becomes significant as to which of the
two chromosomes of each chromosome pair the alleles are on.
E.g. in the above example, whether the D allele is carried on the
same chromosome as the B allele or the b allele would be significant if the genes were linked.
That's because they will tend to either
stay with each other or repel each other during meiosis depending on the probability of crossover occurring between those alleles.
To handle this, when linkage is present Breeders Assistant interprets the first allele of a pair as being on the maternally inherited
chromosome, and the second as being on the paternally inherited chromosome.
Thus
Bb Dd
says that the B and D alleles were inherited maternally, and if they belonged to linked genes, then they will both be on the same
chromosome.
In all other cases the normal convention is to write alleles with the most dominant allele first.
Hence one normally writes Dd rather
than dD.
Polygenes
A 'polygene'
is a trait whose expression in the phenotype has a continuous range of variation and which is considered to be the
result of genetic effects of a collection of multiple, otherwise unspecified, discrete genes.
E.g. many of the more important traits that
dog and cat breeders focus on in selective breeding programmes fall into this category.
Head shape in cats is thought to be
controlled by many genes (probably, very many).
Such traits are often said to have a polygenic mode of inheritance.
In Breeders Assistant a polygenic trait can be assigned a symbol e.g. Hd and you can then enter the 'value' of a polygene e.g. Hd=8.
There is also a means of labeling ranges of polygene values for each polygene.
E.g. in the UK BVA system for scoring hip dysplasia
in dogs a value between 0 (best) and 106 (worst) is possible.
This can be divided into ranges e.g. 0-20 might mean 'good', 21-40
might mean 'borderline', and 41-106 'poor'.
Each range can be assigned a symbol e.g. Hdlow, Hdstd and Hdhigh.
The symbols can
then be used in genotypes instead of an explicit numeric value.
E.g. a chocolate colored dog with good hips might have its genotype
entered as:
bb Hdlow
When Breeders Assistant needs to use an actual numeric value for such a range-specified polygene it will use the midpoint value.
Breeders in the US please note: the OFA grading scheme for hip dysplasia is also supported.
When Breeders Assistant is installed
and the gene configuration selected there is a choice between American and British english versions; the former uses the OFA
grading scheme.
See:
Genotype Fields
28.2. Mendelian Genetics:
Assuming such an error has not occurred you will instead see a prediction included in the certificate, e.g.:
Note, the text of the computed phenotypes and genotypes are completely controlled by the gene configuration currently selected.
See:
Mating Certificates
Both these tests can be carried out from the Genotype tab of the Cat Details window.
The Parent/Offspring check is also available
as one of the database inconsistency checks.
See:
8.10.
Cat Database Files: Database Inconsistency Checking
See Also:
Then for each polygene that is to be analysed the software examines the genotypes of all cats with the given relation to lookup the
'value' of that polygene.
The following statistics are then produced for that set of samples:
Mean ('average')
Variance
Standard Deviation
Coefficient of Variation
Standard Error
Range Analysis - for a polygene with ranges defined, a breakdown of how many samples fell into each range.
7.10.
Fundamental Concepts: Field Codes
See Also:
Help Reference - 4.7.8 Fields And Field Codes Reference: Cat Records: Mendelian Genetics Fields And Field Codes
This is typically accessed by selecting Display|Mendelian Genetics and choosing one of the Gene Probabilities options.
Standard forms are provided to generate a probability analysis to 4 generations of the following genetic dispositions:
Alleles Present - For each allele of each discrete gene, the probability that the allele will be present (either
heterozygously or homozygously).
For alleles associated with dominant traits this gives the likelihood that the cat will
express the trait.
Heterozygous Alleles - For each allele of each discrete gene, the probability that the allele will be present
heterozygously.
For recessive traits this gives the likelihood that the cat will be a carrier.
All Allele Permutations - Both of the above plus the likelihood of each allele being present homozygously.
All Polygenes - A prediction of the 'value' for each polygene.
What this analysis actually does depends on whether the gene is a discrete gene or a polygene.
For discrete genes this concerns the calculation of the probability that a given gene will have particular combination(s) of alleles.
E.g. consider a gene A with two alleles A and a.
What is the likelihood that a cat is heterozygous for this gene i.e. Aa?
This likelihood
can be restated as being the sum of the probability that the cat inherits A from its sire and a from its dam plus the probability that it
inherits a from its sire and A from its dam.
To calculate these probabilities for either parent the software first examines that specific
parent's genotypes.
If the alleles are given for this gene then those probabilities are known absolutely.
Otherwise, they need to be
estimated, in which case it can be done in one of two ways: either the genotypes of its parents can be inspected - and so on as far
back as the analysis permits - to calculate those probabilities, or a default 'background allele distribution probability' is used.
The
latter method is used once the ancestor depth limit has been reached.
For polygenes a simpler approach is used.
The 'value' of a polygene is estimated as being half the sum of the parents values for that
polygene (i.e. the mean of those values).
If a parent's value for that polygene is not set, that is calculated in turn by taking the
mean of the grandparents values, and so on back through the pedigree.
When an ancestor is missing, or when the depth limit of the
analysis has been reached, a default for that polygene is assumed.
NOTES:
1. These
analyses are available when working with cats, matings or trial matings.
2. These analyses are implemented by embedding a <GeneInheritanceProbabilities>
field code within a form.
Variations on
these standard analyses are possible by creating new forms with custom parameters to this field code.
For details see section 7
"Mendelian Genetics Configuration Reference" (p.113) of the Help Reference and section 4.7.8 "Fields And Field Codes Reference:
Cat Records: Mendelian Genetics Fields And Field Codes" of the Help Reference.
7.10.
Fundamental Concepts: Field Codes
Help Reference - 4.7.8 Fields And Field Codes Reference: Cat Records: Mendelian Genetics Fields And Field Codes
Between Traits
This measures the
degree to which any 2 traits - typically polygenes - are inherited alongside each other.
Between Relatives
This measures the heritability of a given trait - typically a polygene - by examining the 'values' of that trait between related
individuals.
The following relationships can be analysed:
Offspring, or
Full siblings, or
Half siblings (sire or dam in common, but not both), or
Sire siblings (sire in common), or
Dam siblings (dam in common), or
All siblings (sire or dam in common, or both)
'Heritability' means the degree to which a given trait is determined through inheritance.
Depending on the relation analysed this
form of covariance analysis can estimate either broad sense heritability (H2) or narrow sense heritability (h2).
The gene probability analysis uses default levels for polygenes in the background population whenever a more accurate estimate is
not available (i.e., one given explicitly for an ancestor).
To change these:
1. Select Configure|Mendelian Genetics.
2. Click the Background Population Defaults button.
3. Move to the Polygene Defaults tab.
4. A list of all the polygenes and their default values is given.
To change a value, click the polygene in the list to select it,
check the 'Use override value' option and enter the value in the box.
To remove the override (i.e. restore to the
default given in the configuration) check the 'Use default' option.
5. Click OK twice.
It is possible to add limited user defined extensions to a standard (inbuilt) gene configuration.
For details see section 7.6 "Mendelian
Genetics Configuration Reference: User Defined Extensions To Inbuilt Configurations" of the Help Reference.
See:
Gene Probability Analysis
28.9. Mendelian Genetics:
See Also:
Help Reference - 7.6 Mendelian Genetics Configuration Reference: User Defined Extensions To Inbuilt Configurations
29.1. Overview
29.2. Population
Genetics Concepts And Terminology
Prospective matings can also be displayed as a matrix with the sires along the top and the dams down the side.
Each cell shows the
ranking and, optionally, other computed values related to the mating.
The cells can be color coded according to the metric shown or
the ranking.
In the following screenshot the prospective inbreeding is shown, color coded with lighter colors indicating a lower
(better) inbreeding:
See:
Population Genetics Concepts And Terminology
29.5. Mate Selection, Kinship And Population Analysis: Mate Selection - Overview
See Also:
29.2. Mate Selection, Kinship And Population Analysis: Population Genetics Concepts And
Terminology
This section defines some of the population genetics concepts and terminology used in this chapter. If you are knowledgable in this
field, you probably don't need to read this section.
Kinship
coefficient between any two cats is the probability, for any particular locus, that an allele selected randomly from one
The kinship
cat is identical by descent to an equivalent allele selected randomly from the other.
Also known as coancestry.
A cat gets half its genes from its father, half from its mother.
The kinship between an offspring and either parent is however one
quarter i.e. 25%, and not one half.
Why is this?
Firstly, there is a 50% chance that any allele chosen at random in a cat is from a
particular parent (the sire, say).
And secondly there is then a 50% chance that it is the same as any particular allele chosen
randomly in the sire.
So, there is a 0.5 * 0.5 chance i.e. 0.25 or 25% that they are identical by descent.
Breeders Assistant can use kinship values when prioritizing prospective matings according to the influence of known individuals.
This
is where the software ranks prospective matings to weight either for or against prospective matings that would result in offspring
that share more or less kinship with the specified individuals.
See section 6 "Mate Selection By Influence" (p.19) of the 'Mate
Selection, Kinship And Genetic Diversity' Tutorial.
To view kinship coefficients directly Breeders Assistant can generate a relationship/kinship matrix for a set of individuals and their
ancestors.
This is accessed using Tools|Population Analysis|Relationship/Kinship Matrix but is also covered in the "Mate
Selection, Kinship And Population Analysis" tutorial.
To access this - and other tutorials - select Tutorials from the Help menu
within Breeders Assistant.
Computing kinship coefficients can require a very large amount of memory - please see 29.4. Memory Requirements When
Computing Kinships for important information and limitations.
Mean Kinship
The mean kinship
of a cat within a group of cats (breeding pool) is the mean of its kinship coefficient with every other member of
the group, including itself.
If a cat's mean kinship (symbol: MK) is low, this means it is less related, on the whole, to the rest of the
population than a cat with a higher MK.
MK plays an important part in breeding decisions in programmes designed to maintain genetic diversity in small populations.
Leaving aside other factors, if it is necessary to choose between one sire and another for a mating decision, it would be better to
choose the one with lower MK.
When using MK it is helpful not to forget that it is the mean kinskip of a cat with respect to every other member of the group of cats
for which it is computed.
The main use of MK is to help make decisions as to which sire to mate to which dam in order to maximize
the retention of genetic diversity.
There is little practical benefit in including individuals that are unavailable for breeding (e.g., are
deceased ancestors) within the group against which MK is computed.
Breeders Assistant can compute mean kinships for a set of individuals as part of its 'gene diversity metrics' analysis. This is
accessed using Tools|Population Analysis|Gene Diversity Metrics and is covered in section 12 "Gene Diversity Metrics and
Mean Kinship" (p.35) of the 'Mate Selection, Kinship And Genetic Diversity' Tutorial.
It is also possible to use mean kinship as a ranking factor when prioritizing prospective matings.
This is described in depth in section
13 "Mate Selection Using Gene Diversity Metrics" (p.37) of the 'Mate Selection, Kinship And Genetic Diversity' Tutorial.
To access this
- and other tutorials - select Tutorials from the Help menu within Breeders Assistant.
Gene Diversity
The gene diversity
of a breeding population is defined as 1 minus the 'mean MK'.
That is to say it is 1 less the arithmetic mean of
the mean kinships of every cat in the breeding pool.
The lower the mean MK, the less related the cats in the breeding pool are.
Gene diversity (symbol: GD) is simply another way of
looking at the mean MK value, but with a number where higher is better.
One of the ranking metrics is 'GD Delta' - which is defined as the change in GD that results from the addition of a single offspring
from a given mating.
If GD increases as a result of a mating, that means the overall genetic diversity of the population has gone up.
So the higher the GD delta, the better.
Inbreeding
Ancestral Inbreeding
The 'ancestral inbreeding
coefficient' of a cat is the cumulative proportion of a cat's genome that has been previously exposed to
inbreeding in its ancestors
(Ballou, JD. "Ancestral Inbreeding Only Minimally Affects Inbreeding Depression in Mammalian
Populations", Journal of Heredity 1997, 8:169-178.).
Pedigree Completeness
This is another measure of the completeness of the pedigree, and probably the most useful.
It is the harmonic mean of the PC
values for the parents of a cat, so long as both parents are present, otherwise it is zero.
Because it is the harmonic mean it weights
the result to the lower of the parent PC values.
This value is computed using the method of MacCluer et al ("Inbreeding and Pedigree Structure in Standardbreed Horses", Journal
of Heredity 1983, 74:394-399).
PCI can be useful when deciding how much importance to give to an inbreeding value.
Informally, if
insufficient ancestry is available then a low inbreeding coefficient is not a reliable guide to the true level of inbreeding.
When
selecting prospective matings by inbreeding Breeders Assistant can use weightings for the sire and dam PCI values in the overall
ranking.
It is possible to specify a PCI threshold to exclude prospective matings that have a PCI value below a given value.
Reproductive Values
A cat in the current population that is no longer reproductive e.g. a female nearing the end of her life, is of no value in maintaining
future genetic diversity (because she can no longer produce offspring to add to the population).
Such individuals should not be
included in the breeding pool if possible.
Likewise it follows that if there are, say, two sires with the same MK, but one is older than the other, then - and ignoring any other
factors - it may be desirable to give a greater priority to breeding from the older sire first, to lessen the risk that its genes are lost
for good.
And yet calculations based on pure MK - such as GD Delta - do not take this into account.
In order to allow for such considerations to contribute to the mating selection, the software can use a 'reproductive value' for each
cat in conjunction with the ranking factors.
The reproductive value can vary from 0 to 1 where 0 means the individual is entirely
unreproductive and 1 means 'fully reproductive'.
Thus an older cat might have a lower reproductive value.
Founders
A founder within a set of pedigree data is defined as a cat where neither the sire nor dam is known.
Such a cat may truly be a
'founding ancestor' of a breed or 'population' in the sense that it is not related to any other founder, or it may be related - possibly
closely - to other members of the group but the details of its lineage are not known.
Within Breeders Assistant founders are treated
as unrelated and non-inbred.
Many of the features of the population analysis and mate selection tools of the Extended Edition of Breeders Assistant involve
determining the ancestors of a cat or group, and then computing various metrics or analyses based on them.
In most situations
Breeders Assistant provides a way to artificially restrict the depth of ancestry considered.
E.g. it may be limited to 16 generations.
Whenever such an artificial cutoff is applied, the definition of founder takes on a slightly different meaning: it means a cat, within
the subset of the population that comprises the cats under study and however many generations of their ancestors that has been
selected, that either has no known sire and/or dam or whose sire and/or dam, even though present in the database, do not fall
within the subset under study.
It is as if the software 'pretends' that the deeper ancestry is simply unknown.
Genome Uniqueness
The genome uniqueness
(symbol: GU) of a cat with respect to a current population of which it is part is the probability that it
contains founder alleles not present in any other single (normally) cat in that current population.
This latter point is crucial to understand - the whole purpose of the GU measure is to identify cats within a breeding population that
are likely to carry genes from founders where there is little or no representation of those genes in other members of the breeding
population.
The term 'normally' is used here because Breeders Assistant lets you configure what is meant by genome uniqueness, in that you
can define that number of cats in the current population for which, if any given founder's alleles are only present in that number, or
fewer, of the current population, then it is considered 'unique'.
This setting can be altered using the Extended Edition preferences
window (use Configure|Preferences ( Ctrl+E), then move to the Extended Edition tab).
A alternative term might be 'genome rarity' or 'founder rarity' however the term 'genome uniqueness' has previously been used in
scientific literature.
Breeders Assistant can compute genome uniqueness for a set of individuals and their founders as part of its 'gene diversity metrics'
analysis. This is accessed using Tools|Population Analysis|Gene Diversity Metrics and is covered in section 12 "Gene Diversity
Metrics and Mean Kinship" (p.35) of the 'Mate Selection, Kinship And Genetic Diversity' Tutorial.
It is also possible to use genome uniqueness as a ranking factor when prioritizing prospective matings.
I.e. to prioritize matings so
as to minimize loss of genetic diversity within a breeding pool.
This is described in depth in section 13 "Mate Selection Using Gene
Diversity Metrics" (p.37) of the 'Mate Selection, Kinship And Genetic Diversity' Tutorial.
To access this - and other tutorials - select
Tutorials from the Help menu within Breeders Assistant.
A gene drop analysis [MacCluer, JW, VandeBerg JL, Read B and Ryder OA. "Pedigree analysis by computer simulation". Zoo Biology
5, 147/160, 1986.] is a computer simulation technique for analyzing a group of individuals comprising a current population and their
ancestors.
The founders of the group are first identified.
The algorithm then simulates Mendelian inheritance by 'dropping' a gene, comprising
pair of unique alleles for each founder, 'through' the pedigree.
The actual alleles that the current descendants have 'received' are
then counted up.
The whole process is then repeated, usually many thousands of times.
By counting the frequencies of the alleles
the descendants end up with, it is possible to work out good approximations for various metrics that otherwise would be difficult to
work out exactly.
Breeders Assistant uses gene drop analysis for the computation of genome uniqueness, and the proportion of alleles retained in the
current population from any given founder.
The number of rounds used in the gene drop analysis is a preference setting (available on the Extended Edition tab of the
Configure|Preferences ( Ctrl+E) window).
The number of founder genome equivalents is a related measure which, unlike the number of founder equivalents, takes genetic
drift into account.
It is the number of equally contributing founders with no random loss of alleles in the offspring that would be
expected to produce the same level of genetic diversity as the current population.
It has standard symbol 'fg'.
The calculation of fg
is more involved than fe because it requires knowledge of the extent to which each founders alleles have been retained in the
current population i.e. the degree of genetic drift.
This can be calculated using a 'gene drop analysis'.
fg will always be less than or
equal to fe.
The number of effective ancestors (symbol: fa) is similar to the number of founder equivalents except that it also takes into account
bottlenecks in the pedigree structure.
This number will always be less than or equal to the number of founder equivalents (fe).
To
arrive at this number it computes the marginal contribution of each ancestor - not just the founders - to the current population to
find the ancestor with the most influence, and then repeats the process taking care
not to consider the contribution of any
previously identified influential ancestor more than once until no more 'significant' ancestors are found.
For details of the method used see [Boichard, D, Maignel L, and Verrier, E. "The value of using probabilities of gene origin to
measure genetic variability in a population". Genetics Selection Evolution, 1997; 29(1): 5-23.].
Breeders Assistant can compute the number founder equivalents, founder genome equivalents and effective ancestors for a set of
individuals as part of its 'founder metrics', 'effective ancestors' and 'gene diversity metrics' analyses. These are accessed using
Tools|Population Analysis|Founder Metrics and Tools|Population Analysis|Gene Diversity Metrics and are covered in the
"Mate Selection, Kinship And Population Analysis" tutorial. To access this - and other tutorials - select Tutorials from the Help
menu within Breeders Assistant.
See:
29.4.
Mate Selection, Kinship And Population Analysis: Memory Requirements When Computing Kinships
See Also:
'Mate Selection, Kinship And Genetic Diversity' Tutorial - 6 Mate Selection By Influence (p.19)
'Mate Selection, Kinship And Genetic Diversity' Tutorial - 12 Gene Diversity Metrics and Mean Kinship (p.35)
'Mate Selection, Kinship And Genetic Diversity' Tutorial - 13 Mate Selection Using Gene Diversity Metrics (p.37)
29.3. Mate Selection, Kinship And Population Analysis: Inbreeding And Related Metrics
Many of the population analysis and mate selection tools include computation of inbreeding coefficients, and related values such as
pedigree completeness, kinship coefficients, etc.
Analyses such as the Key Metrics analysis - and in fact all the features accessed through the Tools|Population Analysis and
Tools|Prospective Matings menus - compute inbreeding when needed using a method that involves analysing all the individuals
concerned and their ancestors as a group, rather than individually (i.e. cat by cat, or mating by mating).
This is done primarily
because it is very much faster when producing reports involving large numbers of records.
But it does mean that, in some
situations, more ancestors are considered when computing inbreeding and/or kinship coefficients than are used elsewhere in
Breeders Assistant, even when the same depth of ancestry is concerned.
These differences disappear when all available ancestry is
taken into account in the calculations.
In comparison whenever Breeders Assistant needs the inbreeding coefficient for an individual record in the context of a pedigree
layout, or in the record list, it does so by considering ancestors to the required depth for that record alone.
This is perhaps best illustrated by an example.
Consider the following pedigree:
Fred is inbred, because his paternal grand-sire 'C' is also a maternal great-great-grand-sire.
If the inbreeding coefficient of Fred is included in a pedigree or as a column in the record list, and the default inbreeding preferences
are used but with just 2 generations of ancestors chosen for the inbreeding calculation, then the inbreeding will be shown in the
pedigree as zero.
This is because when calculating the inbreeding it only finds the ancestors within the first 2 generations of Fred's
pedigree (i.e., 'A', 'B', 'C' and 'D'), and none of those ancestors appear on both sides of the pedigree (to 2 generations).
Now consider what happens when a feature such as the Key Metrics report is used.
This will calculate various metrics including the
inbreeding coefficient for all individuals included in the report at the same time (bulk calculation).
To do this, it first finds all the
ancestors to the chosen depth for all individuals included.
It then computes the inbreeding coefficients for every individual and
ancestor identified in a single step.
Using the above example, if a Key Metrics report is produced just for Fred alone then it would show the inbreeding as zero for the
same reasons as above.
That is because the ancestors located would contain these relations:
Fred -> sire 'A', dam 'B'
But, if instead a Key Metrics report is produced for both Fred and 'D' at the same time (e.g. both Fred and 'D' are tagged and then
the key metrics report is produced for all tag matching cats to 2 generations), the report would now say that Fred's inbreeding is
3.125%. Why?
It is because the ancestors it has now analysed contained these relations:
Fred -> sire 'A', dam 'B'
... and this time the appearance of 'C' on both sides of Fred's pedigree is visisble to the inbreeding computation.
Hence the
coefficient is no longer zero.
See:
Population Genetics Concepts And Terminology
See Also:
29.4. Mate Selection, Kinship And Population Analysis: Memory Requirements When
Computing Kinships
Some analyses - such as the Gene Diversity Metrics and Prospective Matings Prioritized By Gene Diversity Metrics analyses
- require calculation of kinship coefficients.
Anything that requires the calculation of such values is an extraordinarily memory intensive process when large numbers of
individuals are involved.
This is because of the need to compute a 'relationship matrix'.
A relationship matrix is a symmetric matrix of values where the number of rows and columns is equal to the number of individuals
being considered and their ancestors - to the depth of ancestry being considered.
This means the memory required is proportional
to the square of this number.
If the database is large and lots of individuals are requested for inclusion in such a report the system can run out of memory.
In
such circumstances it is therefore important to limit the records included (e.g. the breeding pool) to those cats that are realistic
contenders for breeding as far as is possible.
E.g. if a database has 100,000 individuals and an attempt is made to produce a gene diversity metrics analysis for all records it
would almost certainly fail.
This is because a symmetric matrix with 100,000 rows and 100,000 columns needs to store up to
5,000,000,000 cells, which in the worst case would require approximately 19 Gbytes of main memory, on top of the other memory
requirements of the product.
Clearly no commonly used PCs have anything remotely approaching this amount of memory (at the
time of writing this document).
Furthermore, Breeders Assistant is a 32bit Windows application, and is limited to 2Gb memory (by
Windows).
In practice this means that calculations involving kinships are limited to, typically no more than about 15,000 - 25,000 individuals
(including their ancestors).
The actual limit is not a fixed number because the software uses various techniques internally to
minimize the memory actually needed, and these in turn depend on the structure of the relations within the individuals and their
ancestors being analysed.
Incidentally even if a 64bit version of Breeders Assistant was available, the practical limits on the number of individuals would not
be much higher - this is because it is the amount of physical memory that matters, and at the time of writing few machines have
more than 8Gb typically.
Given that the memory requirement grows proportionally to the square of the matrix size, available
memory would be exhausted rapidly.
With a large database it is important to restrict analyses that use kinship calculations so that the numbers of cats/sires/dams, and
their ancestors to the chosen depth of ancestry, do not cause these memory limitations to be exceeded.
See:
29.5. Mate Selection, Kinship And Population Analysis: Mate Selection - Overview
Breeders Assistant can take a set of potential parents - a list of sires and a list of dams - and rank (prioritize) the prospective
matings between every possible sire/dam pairing in a number of ways, as a tool to making breeding decisions.
There are three different ways of prioritizing the prospective matings:
By Inbreeding - This ranks according to the inbreeding of the potential offspring, and possibly also the inbreeding and
pedigree completeness indices (PCI values) of the parents.
The pedigree completeness index is a useful means of
incorporating the reliability of the inbreeding coefficient into account: when insufficient ancestry is available the
computed inbreeding coefficient may be unrealistically low and it may be desirable to avoid such matings.
Accessed using Tools|Prospective Matings|Prioritized By Inbreeding.
By Influence - This ranks by taking into account the extent of kinship the potential offspring will have with chosen
individuals that have either 'desired' or 'unwanted' influence.
It gives higher priority to matings where the potential
offspring will have greater kinship with the desired individuals, and lower priority to those with greater kinship to
unwanted individuals.
Accessed using Tools|Prospective Matings|Prioritized By Influence.
By Gene Diversity Metrics - This ranks by taking into account other metrics concerning overall genetic diversity of a
breeding pool, such as changes in mean kinship or to prioritize prospective matings to favor those that will
increase the
representation of genes from under-represented founders.
Accessed using Tools|Prospective Matings|Prioritized By Gene Diversity Metrics.
The way all these features are used is broadly the same:
1. The prospective parents are defined, and associated information such as the depth of ancestry to be considered and
the 'reference date' (from which age-related information that can be used when selecting parents is determined).
In
the case of the 'By Influence' and 'By Gene Diversity Metrics' prioritization methods, additional individuals need to be
defined (those with desired/unwanted influence, or the breeding pool).
2. Ranking weightings may optionally be customized - these influence the ranking algorithm.
3. Results are displayed, either as a list of prospective matings ordered by ranking (and many other ways), or as a
matrix with the sires along the top and dams down the side.
4. Results are used either by browsing the displayed results on screen, or by exporting to a text/CSV file (for external
use) or by selecting and creating actual mating records within the software.
See:
29.6. Mate Selection, Kinship And Population Analysis: Mate Selection - Specifying Parents,
Ancestors And Other Parameters
Depth Of Ancestry
The depth of ancestry
- the number of generations of ancestors to be considered - is a key parameter that will influence the results.
This can be set to a fixed # of generations, or it can be set to include all available ancestry within the database.
Increasing the depth leads to more accurate results at the expense of additional computer resources.
Any ranking method that
involves computation of kinship values (as distinct from inbreeding coefficients) has memory requirements that are highly
dependent on the total number of individuals and ancestors that are considered in the report.
If you have a large database and wish
to use kinship data when mate ranking see 29.4. Memory Requirements When Computing Kinships.
Reference Date
When any of the individuals in the analysis are chosen - parents, cats with influence, cats in the current breeding pool - they can be
filtered in various ways, one of which is the age of the individual.
The primary purpose of this is to provide the means to limit the
individuals involved to those that are of breeding age.
The age of any cat is determined by comparing its date of birth to the 'reference date', a date which can be set for each prospective
mating analysis.
Typically the reference date is set to the current date, since in the most common use these features are intended to select actual
breedings that are to be carried out.
But it could be set to a date in the past e.g. to see which matings might have been advisable
previously.
This is the simplest of the three prioritization methods in terms of the selection of individuals that are taken into account.
It is just a
case of specifying the sires and dams.
The parents are chosen by first selecting an index from which they will be drawn - this can simply be an index of all the cats in the
database (such as the 'By name' index), or a selective index.
If tagging is being used it is possible to restrict this to the tag matched
individuals.
Secondly, there is a 'filter' option that allows the sires and dams to be further restricted, separately, according to:
Whether they are tag matched.
Whether they have the active breeding stock checkbox set.
This is a setting on the More tab of the Cat Details
window.
For this option to be visible it is necessary to have 'advanced cat records' enabled (select Configure|
Preferences ( Ctrl+E), move to the User Interface tab, check the 'Use advanced cat records' option and click OK).
Whether or not they are recorded as being dead - i.e. a date of death has been recorded.
Whether or not they are recorded as being neutered.
Whether or not they are younger or older than a given age.
Whether they meet other, custom conditions.
This is a way to add additional record matching conditions on the potential
parents, and is an important facility because it makes it possible to select potential parents according to the values
stored in user defined fields.
Perhaps one of the most common ways of specifying a filter condition for desired influence is to set up a custom index that only
includes the desired individuals, and then just select that index as the definition of the desired cats.
This method is demonstrated in
section 6 "Mate Selection By Influence" (p.19) of the 'Mate Selection, Kinship And Genetic Diversity' Tutorial. To access this - and
other tutorials - select Tutorials from the Help menu within Breeders Assistant.
With this prioritization method it is necessary to first specify the 'breeding pool', and then to add further conditions to restrict the
sires and dams within this breeding pool.
The breeding pool should be set up to be those individuals that make up the current 'active' population - all the individuals that
represent the current pool from which all future individuals must, by definition, be bred.
The breeding pool individuals are specified
in exactly the same way as the parents are specified when when prioritizing by inbreeding/influence - by selecting an index from
which they will be drawn and adding conditions to refine that list.
Common conditions to use are to select all the individuals that are
of breeding age and are known not to be dead.
Once the breeding pool is set, the actual sires and dams whose prospective matings are to be investigated should then be defined.
These are limited to being individuals within the breeding pool but typically will have additional conditions that identify the actual
individuals truly available to be bred.
E.g. if the software is being used to manage breeding within a closed population (say, in zoos
throughout the world) then it may be that the actual parents are to be only those available locally.
One way to limit the parents is to use tagging: tag the sires and dams to be considered and then use the option to limit the parents
to the tag matched individuals.
Another way is to use the 'active breeding stock' option within the cat records and then limit the
parents to those individuals that have that setting.
'Active breeding stock' is found on the More tab of the Cat Details window.
For
this option to be visible it is necessary to have 'advanced cat records' enabled (select Configure|Preferences ( Ctrl+E), move
to the User Interface tab, check the 'Use advanced cat records' option and click OK).
The "Mate Selection, Kinship And Population Analysis" tutorial demonstrates an alternative method - using a custom index that is set
up to only contain the individuals genuinely available for breeding (see section "Mate Selection By Influence"). To access this - and
other tutorials - select Tutorials from the Help menu within Breeders Assistant.
See:
29.2. Mate Selection, Kinship And Population Analysis: Population Genetics Concepts And Terminology
29.4. Mate Selection, Kinship And Population Analysis: Memory Requirements When Computing Kinships
See Also:
'Mate Selection, Kinship And Genetic Diversity' Tutorial - 6 Mate Selection By Influence (p.19)
29.7. Mate Selection, Kinship And Population Analysis: Mate Selection - Rank Computation
Once the parents and other parameters have been set and the analysis is performed Breeders Assistant examines every possible
sire/dam pairing.
First it checks whether the pairing is to be completely ignored.
This happens if the pairing does not meet any of the thresholds as
defined on the Extended Edition tab of the Configure|Preferences ( Ctrl+E) window, as follows:
Max Inbreeding Threshold - If prospective offspring inbreeding - i.e. the inbreeding that any offspring from the
mating would have - is a ranking factor then if the inbreeding threshold is exceeded that sire/dam pairing will be ignored.
This is a way to exclude matings that would give rise to unacceptably inbred individuals.
Note that this threshold is only
considered if prospective offspring inbreeding is itself a ranking factor.
E.g. if ranking by gene diversity metrics to
maximize gene diversity delta with zero weighting to prospective offspring inbreeding, any inbreeding threshold is
ignored.
Min Pedigree Completeness Index Threshold - If, and only if, prospective offspring inbreeding is a ranking factor,
then if the pedigree completeness index (PCI) of the prospective offspring would be less than this threshold the pairing
will be ignored.
This is a way to exclude matings that may give rise to unacceptably inbred individuals (because of the
unreliability of the computed prospective offspring inbreeding, due to insufficient ancestry being available which is where
the PCI value comes in).
Ignore Cats With Zero Reproductive Value - If a prospective parent has no reproductive value it will be ignored.
Once the prospective parents have passed the threshold test their mate ranking is computed.
This is a value that ranges from 0 to
100, with 100 being the best.
To do this it first computes a 'raw rank value' for every possible mating, then scales the raw values so
they all range from 0 to 100.
The formula to compute the raw rank value depends on the prioritization method.
Ranking - By Inbreeding
raw (unscaled) rank value when prioritizing by inbreeding is:
The formula for computing the
Where:
F - is the offspring inbreeding
WF - is the weighting factor for offspring inbreeding (default: 1)
E.g. to include parental PCI as an equal factor in the rank value as the offspring inbreeding the weighting factors for sire and dam
PCI could be set to say 1 each and the offspring inbreeding weighting to 2.
Ranking - By Influence
The formula for computing
the raw (unscaled) rank value when prioritizing by influence is:
Where:
F - is the offspring inbreeding
WF - is the weighting factor for offspring inbreeding (default: 0)
DI - is the mean of the kinships between the prospective offspring with each cat that has desired influence
WD - is the weighting factor for desired influence (default: 1)
UI - is the mean of the kinships between the prospective offspring with each cat that has unwanted influence
WU - is the weighting factor for unwanted influence (default: 1)
The above ranking factors are then combined with weightings to give the overall raw rank value, which is then scaled using the
reproductive values of the sire and dam if necessary.
In formulae, these are the definitions of the ranking factors:
Where:
F is the inbreeding coefficient of the prospective mating offspring
MK is the mean kinship of a single offspring of a prospective mating assuming just one offspring is produced
GD is the gene diversity of the breeding pool plus a single prospective mating offspring
GDbp is the gene diversity of the breeding pool (prior to the addition of prospective mating offspring)
These rank factors are then combined to give a weighted raw rank value:
Where:
SVX - is a scaling factor to adjust for the reproductive values of the sire and dam (see below)
WAMK - is the weighting factor for mean parental mean kinship (default: 0)
WMKD - is the weighting factor for parental mean kinship delta (default: 0)
WMMK - is the weighting factor for minimum parental mean kinship (default: 0)
WAGU - is the weighting factor for mean parental genome uniqueness (default: 0)
WMGU - is the weighting factor for maximum parental genome uniqueness (default: 0)
When reproductive values are not used, the scaling factor SVX in the above formula is 1. Ie., no scaling.
But if reproductive values are used, the scaling factor is defined as:
SVX = 1 + H(1-Vxs,1-Vxd)
Where:
H(x,y) is the harmonic mean of x and y
Vxs is the reproductive value of the sire
I.e., as the mean of the parental reproductive values goes down, the scaling factor increases.
The intent is that, all other factors
being equal, priority can be given to matings that involve individuals likely to disappear from the breeding pool sooner than others.
This can be done directly from any of the mate ranking windows.
Click the Preferences button, then click the Change Weightings
button to display the Prospective Mating Weightings window.
Alternatively use Configure|Preferences ( Ctrl+E), select the Extended Edition tab, then click the Change Weightings
button to display the Prospective Mating Weightings window.
See:
29.8. Mate Selection, Kinship And Population Analysis: Mate Selection - Results
Prospective matings can be displayed in either list or matrix format - use either the Display Matings (List) or Display Matings
(Matrix) button within the Prospective Matings window.
Symbols can be used instead of descriptions for the column headings by enabling the Use symbols preference setting.
To change
this use Configure|Preferences ( Ctrl+E) and move to the Extended Edition tab.
When shown as a matrix the prospective matings are shown as a color coded grid with columns for the sires, rows for the dams, and
the rank values shown in the cells.
The default color coding shows better (higher) rank values with deeper shades of blue:
Selecting Results
prospective matings - can be 'chosen' by double-clicking them (in the list format double-click a row or, in the
Individual results - i.e.
matrix format, double-click a cell).
When a prospective mating is chosen in this way it is displayed with an asterisk ('*') either in the rank column (list mode) or in the
cell (matrix mode).
When the results window is closed, if there are any such selected matings Breeders Assistant then prompts what to do with them.
Choices are to either add mating/trial mating records, and/or to export the chosen matings to a text/CSV file.
See:
Mating Records
17. Trial
See Also:
29.9. Mate Selection, Kinship And Population Analysis: Population Analysis - Overview
A number of tools are available to compute inbreeding coefficients and various measures of genetic diversity such as mean kinships
and genome uniqueness values.
These are all accessed using the Tools|Population Analysis menu:
Key Metrics - Computes inbreeding coefficients, pedigree completeness metrics such as PCI values, and genome
completeness coefficients for a given set of cats.
Founder Metrics - Computes the contribution, alleles retained, and founder genome uniqueness of all the founders of a
given set of cats with respect to that set.
Normally used to compute founder metrics of the current breeding pool of a
closed population.
Founder Contributions - Analyses the estimated contributions made by each founder to each cat, separately, in a given
set of cats with respect to that set.
Normally used to compute the individual founder contributions to each cat of each
founder of the current breeding pool of a closed population.
Founder Genome Uniquenesses - Analyses the founder genome uniqueness of every founder with respect to each cat
in a given set of cats.
Relationship/Kinship Matrix - Displays a relationship matrix of additive genetic relations (also known as the 'NRM' or
'A' matrix), or a matrix of of kinship coefficients, of a given set of cats, their ancestors and optionally descendants.
Gene Diversity Metrics - Computes mean kinships and genome completeness coefficients for a given set of cats.
This is
typically used to find gene diversity metrics of the current breeding pool of a closed population.
Effective Ancestors - Computes the most effective, i.e. influential, ancestors behind a given set of cats [using the
method of Boichard, D, Maignel L, and Verrier, E. "The value of using probabilities of gene origin to measure genetic
variability in a population", Genetics Selection Evolution, 1997; 29(1): 5-23].
Depth Of Ancestry
Reference Date
The individuals chosen can be filtered in various ways, one of which is the age of the individual.
E.g. this can be used to limit the
individuals included to those of breeding age.
The age of any cat is determined by comparing its date of birth to the 'reference date'.
Typically the reference date is set to the
current date, but it could be set to a date in the past e.g. to produce a historical analysis.
See:
Population Genetics Concepts And Terminology
See Also:
Genetic Diversity
Mean Kinship
29.10. Mate Selection, Kinship And Population Analysis: Population Analysis - Results
Results are displayed in either list or matrix format - depending on the particular analysis.
Results are shown in rows with columns for the name and the various metrics computed, e.g.:
Symbols can be used instead of descriptions for the column headings by enabling the Use symbols preference setting.
To change
this use Configure|Preferences ( Ctrl+E) and move to the Extended Edition tab.
The results are shown as a color coded grid with rows and columns as follows:
Founder Contributions - Columns represent the founders, rows represent the breeding pool.
Additional rows give the
overall contribution of each founder to the whole set, and the overall proportion of alleles retained from each founder.
Founder Genome Uniquenesses - Columns represent the founders, rows represent the breeding pool.
Additional rows
give the founder genome uniqueness with respect to the whole set, and the overall proportion of alleles retained from
each founder.
Relationship Matrix - Both rows and columns represent the individuals and their descendants for which the matrix has
been computed, optionally including the ancestors used in the calculations.
on the 'Right header' or 'Bottom header' options (above the grid) in order to see the values by which the rows/columns
have been sorted.
Resize Cells - The cells (and the left/top headers) can be resized by dragging the edges of the top-left cell (only) in the
results grid.
Side Panel - There is an options side panel at the right, which can be made visible by dragging the thick vertical resizing
bar to the right of the main results grid.
The side panel always shows details for the currently selected row and column.
Export - The Export button can be used to save the results grid as currently displayed (and ordered) as a text/CSV file.
See:
29.2.
Mate Selection, Kinship And Population Analysis: Population Genetics Concepts And Terminology
See Also:
Genetic Diversity
Mean Kinship
29.11. Mate Selection, Kinship And Population Analysis: Configuration And Preferences
Most preferences for the mate selection and population analysis features are found on the Extended Edition tab of the Configure|
Preferences ( Ctrl+E) window.
For further details see section 11.8 "Preferences And Configuration Reference: Extended Edition"
of the Help Reference.
These preferences can be accessed from the main window by selecting Preferences from the Configure menu, then moving to the
Extended Edition tab.
Alternatively, within any of the population analysis and prospective mating tools there is a Preferences
button that will display the same preferences (though note that a small number of settings cannot be changed this way; to be able
to change all of the preferences it needs to be accessed through the main menu).
Precision Of Coefficients
The same precision (number
of decimal places) as set for the inbreeding coefficient is used for all coefficients within the mate
selection and population analysis features e.g. the for mean kinships and genome uniqueness values.
This precision is set on the Inbreeding tab of the Configure|Preferences ( Ctrl+E) window.
See:
Population Genetics Concepts And Terminology
See Also:
For further information about these settings click the Help button from the Preferences window.
See:
Mate Selection - Overview
29.5. Mate Selection, Kinship And Population Analysis:
See Also: