# Record Linkage and Epidemiological Case Definitions in 'R'

## Documentation for package ‘diyar’ version 0.5.1

- DESCRIPTION file
- User guides, package vignettes and other documentation
- Package NEWS
- Package README

## Help Pages

A B C D E F H I L M N O P R S T U W X Y misc

## -- A --

across | Overlapping number line objects
aligns_end | Overlapping number line objects
aligns_start | Overlapping number line objects
as.data.frame.d_report | d_report
as.data.frame.epid | 'epid' object
as.data.frame.number_line | 'number_line' object
as.data.frame.pane | 'pane' object
as.data.frame.pid | 'pid' objects
as.epid | 'epid' object
as.list.d_report | d_report
as.list.epid | 'epid' object
as.list.number_line | 'number_line' object
as.list.pane | 'pane' object
as.list.pid | 'pid' objects
as.number_line | 'number_line'
as.pane | 'pane' object
as.pid | 'pid' objects
attrs | Match criteria
attr_eval | Sub-criteria attributes.

## -- B --

bys_count | Vectorised approach to group operations.
bys_cummax | Vectorised approach to group operations.
bys_cummin | Vectorised approach to group operations.
bys_cumprod | Vectorised approach to group operations.
bys_cumsum | Vectorised approach to group operations.
bys_funcs | Vectorised approach to group operations.
bys_lag | Vectorised approach to group operations.
bys_lead | Vectorised approach to group operations.
bys_max | Vectorised approach to group operations.
bys_min | Vectorised approach to group operations.
bys_nval | Vectorised approach to group operations.
bys_position | Vectorised approach to group operations.
bys_prod | Vectorised approach to group operations.
bys_rank | Vectorised approach to group operations.
bys_sum | Vectorised approach to group operations.
bys_val | Vectorised approach to group operations.

## -- C --

c-method | 'epid' object
c-method | 'number_line' object
c-method | 'pane' object
c-method | 'pid' objects
chain | Overlapping number line objects
combi | Vector combinations
custom_sort | Nested sorting

## -- D --

decode | Labelling in 'diyar'
decode.default | Labelling in 'diyar'
decode.d_label | Labelling in 'diyar'
delink | Unlink group identifiers
delink.epid | Unlink group identifiers
delink.pane | Unlink group identifiers
delink.pid | Unlink group identifiers
d_report | d_report

## -- E --

encode | Labelling in 'diyar'
encode.default | Labelling in 'diyar'
encode.d_label | Labelling in 'diyar'
end_point | 'number_line'
end_point<- | 'number_line'
epid-class | 'epid' object
epid_lengths | Windows and lengths
epid_windows | Windows and lengths
episodes | Group dated events into episodes.
episodes_af_shift | Group dated events into episodes.
episodes_wf_splits | Link events to chronological episodes.
episode_unit | Datasets in 'diyar' package
eval_sub_criteria | Match criteria
eval_sub_criteria.sub_criteria | Match criteria
exact | Overlapping number line objects
exact_match | Predefined logical tests in *'diyar'*
exclude_overlap_method | Overlapping number line objects
expand_number_line | 'number_line'

## -- F --

false | Predefined logical tests in *'diyar'*
format.epid | 'epid' object
format.number_line | 'number_line' object
format.pane | 'pane' object
format.pid | 'pid' objects
format.sub_criteria | Match criteria

## -- H --

hospital_admissions | Datasets in 'diyar' package
hourly_data | Datasets in 'diyar' package

## -- I --

inbetween | Overlapping number line objects
include_overlap_method | Overlapping number line objects
index_window | Windows and lengths
infections | Datasets in 'diyar' package
infections_2 | Datasets in 'diyar' package
infections_3 | Datasets in 'diyar' package
infections_4 | Datasets in 'diyar' package
intersect_number_lines | Set operations on number line objects
invert_number_line | 'number_line'
is.epid | 'epid' object
is.number_line | 'number_line'
is.pane | 'pane' object
is.pid | 'pid' objects

## -- L --

left_point | 'number_line'
left_point<- | 'number_line'
links | Multistage record linkage
links_af_probabilistic | Record linkage
links_wf | Record linkage
links_wf_episodes | Group dated events into episodes.
links_wf_probabilistic | Record linkage
link_wf | Record linkage
listr | Grammatical lists.

## -- M --

make_episodes | Create 'epid' and 'pid' objects with index of matching records
make_ids | Convert an edge list to record identifiers.
make_pairs | Combinations and permutations of record-sets.
make_pairs_wf_source | Combinations and permutations of record-sets.
make_pids | Create 'epid' and 'pid' objects with index of matching records
make_s4_ids | Create 'epid' and 'pid' objects with index of matching records
make_sets | Combinations and permutations of record-sets.
merge_identifiers | Merge group identifiers
merge_ids | Merge group identifiers
merge_ids.default | Merge group identifiers
merge_ids.epid | Merge group identifiers
merge_ids.pane | Merge group identifiers
merge_ids.pid | Merge group identifiers
missing_staff_id | Datasets in 'diyar' package

## -- N --

none | Overlapping number line objects
number_line | 'number_line'
number_line-class | 'number_line' object
number_line_sequence | 'number_line'
number_line_width | 'number_line'

## -- O --

Opes | Datasets in 'diyar' package
overlap | Overlapping number line objects
overlaps | Overlapping number line objects
overlap_method | Overlapping number line objects
overlap_methods | Datasets in 'diyar' package
overlap_method_codes | Overlapping number line objects
overlap_method_names | Overlapping number line objects

## -- P --

pane-class | 'pane' object
partitions | Distribute events into specified intervals.
patient_list | Datasets in 'diyar' package
patient_list_2 | Datasets in 'diyar' package
patient_records | Datasets in 'diyar' package
pid-class | 'pid' objects
plot.d_report | d_report
predefined_tests | Predefined logical tests in *'diyar'*
print.epid_summary | 'epid' object
print.pane_summary | 'pane' object
print.pid_summary | 'pid' objects
print.sub_criteria | Match criteria
prob_link | Predefined logical tests in *'diyar'*
prob_score_range | Record linkage

## -- R --

range_match | Predefined logical tests in *'diyar'*
reframe | Modify 'sub_criteria' objects
reframe.sub_criteria | Modify 'sub_criteria' objects
rep-method | 'epid' object
rep-method | 'number_line' object
rep-method | 'pane' object
rep-method | 'pid' objects
rep.d_label | Labelling in 'diyar'
reverse_number_line | 'number_line'
right_point | 'number_line'
right_point<- | 'number_line'

## -- S --

schema | Schema diagram for group identifiers
schema.epid | Schema diagram for group identifiers
schema.number_line | Schema diagram for group identifiers
schema.pane | Schema diagram for group identifiers
schema.pid | Schema diagram for group identifiers
seq.number_line | 'number_line' object
sets | Combinations and permutations of record-sets.
set_operations | Set operations on number line objects
shift_number_line | 'number_line'
show-method | 'epid' object
show-method | 'number_line' object
show-method | 'pane' object
show-method | 'pid' objects
sort.number_line | 'number_line' object
staff_records | Datasets in 'diyar' package
start_point | 'number_line'
start_point<- | 'number_line'
subtract_number_lines | Set operations on number line objects
sub_criteria | Match criteria
summary.epid | 'epid' object
summary.pane | 'pane' object
summary.pid | 'pid' objects

## -- T --

true | Predefined logical tests in *'diyar'*

## -- U --

union_number_lines | Set operations on number line objects
unique.epid | 'epid' object
unique.number_line | 'number_line' object
unique.pane | 'pane' object
unique.pid | 'pid' objects

## -- W --

windows | Windows and lengths

## -- X --

x_across_y | Overlapping number line objects
x_aligns_end_y | Overlapping number line objects
x_aligns_start_y | Overlapping number line objects
x_chain_y | Overlapping number line objects
x_inbetween_y | Overlapping number line objects

## -- Y --

y_across_x | Overlapping number line objects
y_aligns_end_x | Overlapping number line objects
y_aligns_start_x | Overlapping number line objects
y_chain_x | Overlapping number line objects
y_inbetween_x | Overlapping number line objects

## -- misc --

$-method | 'number_line' object
$<--method | 'number_line' object
[-method | 'epid' object
[-method | 'number_line' object
[-method | 'pane' object
[-method | 'pid' objects
[.d_label | Labelling in 'diyar'
[<--method | 'number_line' object
[[-method | 'epid' object
[[-method | 'number_line' object
[[-method | 'pane' object
[[-method | 'pid' objects
[[.d_label | Labelling in 'diyar'
[[<--method | 'number_line' object