Learn R Programming

IFC (version 0.2.1)

Tools for Imaging Flow Cytometry

Description

Contains several tools to treat imaging flow cytometry data from 'ImageStream®' and 'FlowSight®' cytometers ('Amnis®' 'Cytek®'). Provides an easy and simple way to read and write .fcs, .rif, .cif and .daf files. Information such as masks, features, regions and populations set within these files can be retrieved for each single cell. In addition, raw data such as images stored can also be accessed. Users, may hopefully increase their productivity thanks to dedicated functions to extract, visualize, manipulate and export 'IFC' data. Toy data example can be installed through the 'IFCdata' package of approximately 32 MB, which is available in a 'drat' repository . See file 'COPYRIGHTS' and file 'AUTHORS' for a list of copyright holders and authors.

Copy Link

Version

Install

install.packages('IFC')

Monthly Downloads

283

Version

0.2.1

License

GPL-3

Maintainer

Yohann Demont

Last Published

September 13th, 2023

Functions in IFC (0.2.1)

BatchReport

Batch Generation of Graphical and Statistic Report
ExportToGallery

Gallery Export
CreateGraphReport

Graph Report Generation
DisplayGallery

Gallery Display
ExportToDAF

DAF File Writer
ExportToFCS

FCS File Writer
ExportToBATCH

Batch File Writer
ExportToNumpy

Numpy Export
BatchStatsReport

Batch Generation of Statistic Report
DisplayReport

Graphical and Statistic Report Display
ExtractFromXIF

RIF/CIF File Reader
ExtractImages_toFile

Shortcut for Batch Images Extraction to Files
ExportToReport

Graphical and Statistic Report Generation
ExtractImages_toBase64

Shortcut for Batch Images Extraction to Base64
ExportToXIF

RIF/CIF File Writer
ExtractImages_toMatrix

Shortcut for Batch Images Extraction to Matrices/Arrays
ExtractFromDAF

DAF File Reader
ExtractFromFCS

FCS File Reader
FCS_merge_dataset

FCS Object Data Sets Merging
ExtractMasks_toMatrix

Shortcut for Batch Masks Extraction to Matrices/Arrays
addScaleBar

Image Scale Bar Incrustation
addText

Image Text Incrustation
StatsReport

Statistical Report Generation
FCS_check_keywords

FCS Keyword Checker
XIFtoTIFF

RIF/CIF File Conversion to TIFF
buildFeature

IFC Feature Coercion
buildBatch

Batch Builder
base_axis_constr

Axis Constructor
FCS_merge_sample

FCS Object Samples Merging
ExtractMasks_toBase64

Shortcut for Batch Masks Extraction to Base64
base_hist_constr

Histogram Constructor for 'base' Plot
checkColor

Character Color Check and RGB Conversion
checkObj

`IFC_data` Object Check
buildStats

IFC Statistics Coercion
autoplot

Automatic Parameters Detection for IFC Graphs
buildIFD

Image Field Directory Builder
buildGraph

IFC Graph Coercion
buildPopulation

IFC Population Coercion
base64_encode

Raw Images to Base64 Encoding
calcDensity

2D Binned Kernel Density Estimation
cpp_base64_encode

Raw to Base64 Conversion
checksumIFC

IFC Files Checksum
ExtractMasks_toFile

Shortcut for Batch Masks Extraction to Files
checksumDAF

DAF File Checksum
cpp_checkTIFF

TIFF Checker
IFC-package

Tools for Imaging Flow Cytometry
applyTrans

Apply Transformation
cpp_fast_range

Use Rcpp for Range
FCS_to_data

FCS Object Converter
collapse_raw

Raw Vectors Collapse
cpp_fast_rowAny

Use Rcpp to Apply Any on Matrix Rows
adjustGraph

IFC Graph Adjustment
cpp_checksum

Checksum for RIF/CIF
checksumXIF

RIF/CIF File Checksum
colConv

Integer to Hexadecimal Color Conversion
assert

Assert that Certain Conditions are Met
computeGamma

Image Gamma Computation
cpp_crop

Matrix Cropping
cpp_fast_listAny

Use Rcpp to Apply Any on List members
cpp_fast_factor

Fast Factorize Vector
applyGatingStrategy

Apply Gating Strategy
cpp_cleanse

Matrix Cleanser
buildImage

IFC Image Coercion
cpp_getoffsets_noid

IFC_offsets Computation without Id Determination
buildMask

IFC Mask Coercion
buildRegion

IFC Region Coercion
cpp_as_nativeRaster

Image to Native Raster Conversion
cpp_assert

Input Parameters Assertive Tool
cpp_extract

IFC_object Extraction
cpp_scanFirst

File Scanner
cpp_M_HSV2RGB

Matrix HSV to RGB Conversion
cpp_align

Spatial Offsets Image Correction
cpp_resize

Matrix Resizing
cpp_draw

Draw Shape to Image
convert_spillover

Spillover Converter
cpp_ell_coord

Ellipse Boundaries to Coordinates
coord_to_px

User's Coordinates to Pixels Conversion
cpp_mark

Matrix to Matrix Writer According to Mask with Offsets
cpp_computeGamma

Gamma Computation
cpp_decomp

IFC_object Decompression
cpp_mask

Equal Sized Matrix to Matrix Writer According to Mask
data_add_features

Add Feature to IFC_data Object
cpp_writeBMP

BMP Writer
cpp_replace_non_finite

Non Finite Values Replacement
cpp_getoffsets_wid

IFC_offsets Computation with Object Identification
cpp_rawdecomp

IFC_object Decompression to RAW
cpp_mpfmatch

Multiple Pattern Fixed Matching
cpp_int32_to_uint32

Int32 to Uint32 32bits Conversion
cpp_group_df

Data Frame Merge Groups with Rcpp
cpp_v_int32_to_uint32

Vectorize Int32 to Uint32 32bits Conversion
cpp_normalize

Matrix Normalization
cpp_fastTAGS

IFD Fast Tags Extraction
cpp_uint64_to_int64

Uint64 to Int64 64bits Conversion
cpp_uint32_to_raw

Uint32 to Raw Conversion
fastCbind

Combine by Columns
cpp_int64_to_uint64

Int64 to Uint64 64bits Conversion
data_rm_pops

Remove Population from an IFC_data Object
data_rm_regions

Remove Region from an IFC_data Object
cpp_offset_to_raw

Offset to Raw Conversion
extractStats

Statistics Extraction
fromXML2_gating

GatingML Conversion from XML2
formatn

File Path Placeholders Formatting
fastAny

Any with Rcpp
getIFD

RIF/CIF Image Field Directories Extraction
cpp_v_int64_to_uint64

Vectorize Int64 to Uint64 64bits Conversion
get_feat_value

Feature Values Computation
cpp_fast_sample

Use Rcpp for Sampling
featureIFC

List IFC features
cpp_coord_to_px

Coordinates to Pixels
getASSIST

ASSIST Database Extraction
gen_altnames

Alternative Names Generator
cpp_getTAGS

IFD Tags Extraction
cpp_getBits

Get Current Compilation Bits Depth
data_add_graphs

Add Graphs to IFC_data Object
cpp_raster

Raster Image
inv_colConv

Hexadecimal to Integer Color Conversion
cpp_pnt_in_gate

Point in Gate
cpp_get_bytes_order

Get Bytes Order
inv_smoothAsinh

Inverse Smooth Asinh Transformation
cpp_inv_smoothLinLog

Inverse Smooth LinLog Transformation with Rcpp
myScales

Scale Constructor for IFC Graphs Plotting
get_pops_stats

Statistics Extraction from Populations
data_add_pop_sample

Population Sampling
cpp_transform

Matrix Transformation
data_rm_features

Remove Features from an IFC_data Object
data_rm_graphs

Remove Graph from an IFC_data Object
expand_list

XML Node List Expansion
escape_entities

XML Entities Protection
inv_smoothLinLog

Inverse Smooth LinLog Transformation
endPB

Progress Bar Terminator
densCols

Colors for Smooth Density Plots
cpp_raw_to_offset

Offset to Raw Conversion
getImagesValues

RIF/CIF Image Values Extraction
getFileExt

File Extension Retrieval
layoutReport

Report Layout Extraction
getAborted

Aborted Batch Files Retrieval
parseTrans

Parse Transformation Information
pan_smooth

Histogram Smooth Constructor
newPB

Progress Bar Initializer
parseFCSname

FCS Name Parser
plotGraph

Plot and Stats Computation for IFC Graph
data_to_DAF

DAF File Writer
data_add_regions

Add Region to IFC_data Object
data_add_pops

Add Population to IFC_data Object
cpp_smoothLinLog

Smooth LinLog Transformation with Rcpp
data_to_AST

AST File Writer
cpp_seqmatch

Sequence of Strings Matching
cpp_uint32_to_int32

Uint32 to Int32 32bits Conversion
popsOrderNodes

IFC_pops Population Level Ordering
feature_namer

Feature Default Name Computation
getOffsets

RIF/CIF File Image Field Directories Offsets Extraction
getFullTag

Image Field Directory Full Tag Retrieval
getInfo

IFC File Information Extraction
fetch_seed

Seed Instructions Extraction
data_modify_pops

Modify Populations within IFC_data Object
map_color

Color Mapping
getLuminance

Luminance Computation
data_modify_regions

Modify Populations within IFC_data Object
get_coordmap_raw

Device Raw Coordinates
map_style

Style Mapping
get_coordmap_adjusted

Device Adjusted Coordinates
getFeaturesValues

Features Values Extraction
objectDisplay

Object Display
popsRename

Populations Renaming
hist_constr

Histogram Constructor
getSTATSREPORT

Statistics Report Template Extraction
gseq

String Sequence Replacement
objectParam

Object Extraction Parameters Definition
popsCompute

IFC_pops Computation
objectCleanse

Object Cleanser
pan_hist

Lattice Histogram Panel Contructor
objectColorize

Object Colorizer
readFCSheader

FCS Header Parser
readFCSdelimiter

FCS Delimiter Reader
popsRetrieveGraph

Graph Retrieval from Graphical IFC_pops
popsWithin

IFC_pops Checker for Object Membership to Populations
objectNormalize

Object Intensity Normalization
objectExtract

Object Extraction
popsGetObjectsIds

IFC_pops Object Numbers
redefine_features_def_feat

IFC_features_def Feature Redefinition
redefine_features_def

IFC_features_def Redefinition
readFCSdata

FCS Data Parser
pan_key

Lattice Key Panel Contructor
popsGetLevels

IFC_pops Levels Dependency Determination
polyExtractTo

Shortcut for Batch Images or Masks Extraction
smoothLinLog

Smooth LinLog Transformation
subsetOffsets

IFC_offset Subsetting
pow2

Power of Two
num_to_string

Numeric to String Formatting
redefine_masks_image

IFC_masks Image Redefinition
readFCSdataset

FCS Dataset Parser
objectWrite

Object File Export
objectResize

Object Resizing
specialr

Special Character Replacement
next_bool

Next Component Prediction
paletteIFC

R/IDEAS Color Palette Mapping
popsNetwork

IFC_pops Network Display
popsGetSiblings2

IFC_pops Sibling Population from Same Region Identification
redefine_masks_mask

IFC_masks Mask Redefinition
plot_raster

`IFC_plot` Conversion to 'raster' Plot
plot_stats

`IFC_plot` Statistics Extraction
pseudo_seed

Pseudo Seed
protectn

Name Protection
readGatingStrategy

Gating Strategy File Reader
split_feat

IFC_features_def Definition Splitting
get_ylim

Histogram y-Axis Limits Constructor
readIFC

IFC Files Generic Reader
subsetXIF

RIF/CIF File Subsetting
swap_channel

Channel Swap
random_name

Random Name Generator
plot_base

`IFC_plot` Conversion to 'base' Plot
group

Groups Combination
splitn

String Decomposition with Operators
toXML2_boolpop_gs

Boolean Population GatingML Conversion to XML2
splitp

String Decomposition with Placeholders
relayout

Change Graphs Layout
toCapFirstOnly

First Letter Only Capitalization
redefine_obj

IFC_data Redefinition
splitf

File Path Decomposition
mergeXIF

RIF/CIF File Merging
plot_lattice

`IFC_plot` Conversion to 'lattice' Plot
popsCopy

Copy Populations from One File to Another File
modifyGamma

Image Gamma Modification
trunc_string

String Truncation
toEllipse

Ellipsoid Polygon Constructor
toXML2_images

IFC_images XML Conversion
switch_channel

Channel Switch
tryReportFileCreation

Report File Creation
objectTransform

Object Transformation
toXML2_graphs

IFC_graphs XML Conversion
toXML2_features

IFC_features XML Conversion
toXML2_masks

IFC_masks XML Conversion
popsGetAffiliation

IFC_pops Affiliation Finder
readFCS

FCS File Parser
toXML2_pops

IFC_pops XML Conversion
popsGetSiblings1

IFC_pops Sibling Population from Same Base Identification
rasterplot

Fast 2D plot
writeIFC

IFC Files Generic Writer
popsGetSiblings

IFC_pops Sibling Population Identification
validate_bool

Boolean Expression Validation
writeGatingStrategy

Gating Strategy File Writer
redefine_features_def_msk_img

IFC_features_def Mask or Image Redefinition
val_constr

Histogram Val Constructor
toXML2_regions

IFC_regions XML Conversion
usedefault_obj

IFC_data Default Naming
readFCStext

FCS Text Parser
testXIF

RIF/CIF Image Order Test
xml_new_node

List to XML Conversion
redefine_masks

IFC_masks Redefinition
type_constr

Histogram Type Constructor
smoothAsinh

Smooth Asinh Transformation
setPB

Progress Bar Updater
writeIFD

Image Field Directory Writer
readGatingML

GatingML File Reader
toXML2_graphs_gs

IFC_graphs GatingML Conversion
toBIN_images

IFC_images Raw Conversion
texttomatrix

Text to Image Conversion
remove_ext

File Extension Removal
toXML2_graphpop_gs

Graphical Population GatingML Conversion to XML2
to_list_node

XML Node to List Conversion
toBIN_features

IFC_features Raw Conversion
rev_string

Reverse String
toXML2_spillover_gs

Spillover GatingML Conversion
toXML2_stats

IFC_stats XML Conversion
toXML2_features_def

IFC_features_def XML Conversion
to_xml_list

List to XML Node Conversion
with_seed

With Seed Evaluation
whoami

Input Identification