Learn R Programming

⚠️There's a newer version (0.2.1) of this package.Take me there.

IFC (version 0.1.6)

Tools for Imaging Flow Cytometry

Description

Contains several tools to treat imaging flow cytometry data from 'ImageStream®' and 'FlowSight®' cytometers ('Amnis®', part of 'Luminex®'). 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.1.6

License

GPL-3

Maintainer

Yohann Demont

Last Published

August 22nd, 2022

Functions in IFC (0.1.6)

DisplayReport

Graphical and Statistic Report Display
ExportToDAF

DAF File Writer
ExportToReport

Graphical and Statistic Report Generation
ExportToNumpy

Numpy Export
BatchReport

Batch Generation of Graphical and Statistic Report
ExportToBATCH

Batch File Writer
DisplayGallery

Gallery Display
CreateGraphReport

Graph Report Generation
ExportToFCS

FCS File Writer
FCS_merge_dataset

FCS Object Data Sets Merging
ExtractMasks_toMatrix

Shorcut for Batch Masks Extraction to Matrices/Arrays
ExtractImages_toMatrix

Shorcut for Batch Images Extraction to Matrices/Arrays
adjustGraph

IFC Graph Adjustment
ExtractImages_toBase64

Shorcut for Batch Images Extraction to Base64
ExtractImages_toFile

Shorcut for Batch Images Extraction to Files
addScaleBar

Image Scale Bar Incrustation
addText

Image Text Incrustation
XIFtoTIFF

RIF/CIF File Conversion to TIFF
ExtractFromFCS

FCS File Reader
applyGatingStrategy

Apply Gating Strategy
FCS_merge_sample

FCS Object Samples Merging
applyTrans

Apply Transformation
ExportToGallery

Gallery Export
ExtractFromDAF

DAF File Reader
ExportToXIF

RIF/CIF File Writer
FCS_to_data

FCS Object Converter
checksumXIF

RIF/CIF File Checksum
base_axis_constr

Axis Constructor
base64_encode

Raw Images to Base64 Encoding
buildFeature

IFC Feature Coercion
buildGraph

IFC Graph Coercion
IFC-package

Tools for Imaging Flow Cytometry
buildIFD

Image Field Directory Builder
buildPopulation

IFC Population Coercion
buildRegion

IFC Region Coercion
cpp_M_HSV2RGB

Matrix HSV to RGB Conversion
cpp_base64_encode

Raw to Base64 Conversion
calcDensity

2D Binned Kernel Density Estimation
buildStats

IFC Statistics Coercion
colConv

Integer to Hexadecimal Color Conversion
buildMask

IFC Mask Coercion
cpp_align

Spatial Offsets Image Correction
cpp_as_nativeRaster

Image to Native Raster Conversion
checkColor

Character Color Check and RGB Conversion
checkObj

`IFC_data` Object Check
cpp_assert

Input Parameters Assertive Tool
cpp_int32_to_uint32

Int32 to Uint32 32bits Conversion
cpp_checkTIFF

TIFF Checker
cpp_crop

Matrix Cropping
checksumDAF

DAF File Checksum
checksumIFC

IFC Files Checksum
collapse_raw

Raw Vectors Collapse
ExtractFromXIF

RIF/CIF File Reader
autoplot

Automatic Parameters Detection for IFC Graphs
computeGamma

Image Gamma Computation
assert

Assert that Certain Conditions are Met
cpp_decomp

IFC_object Decompression
base_hist_constr

Histogram Constructor for 'base' Plot
cpp_computeGamma

Gamma Computation
cpp_int64_to_uint64

Int64 to Uint64 64bits Conversion
getInfo

IFC File Information Extraction
cpp_extract

IFC_object Extraction
cpp_fastTAGS

IFD Fast Tags Extraction
cpp_fast_cbind_M_M

Matrix and Matrix Column Binding
cpp_fast_cbind_M_DF

Fast Matrix and Dataframe Column Binding
cpp_fast_cbind_DF_DF

Dataframe and Dataframe Column Binding
convert_spillover

Spillover Converter
coord_to_px

User's Coordinates to Pixels Conversion
cpp_fast_factor

Fast Factorize Vector
cpp_fast_listAny

Use Rcpp to Apply Any on List members
cpp_inv_smoothLinLog

Inverse Smooth LinLog Transformation with Rcpp
cpp_mark

Matrix to Matrix Writer According to Mask with Offsets
cpp_fast_cbind_DF_L

Fast Dataframe and List Column Binding
cpp_fast_cbind_L_DF

Fast List and Dataframe Column Binding
cpp_fast_cbind_DF_M

Fast Dataframe and Matrix Column Binding
cpp_uint32_to_int32

Uint32 to Int32 32bits Conversion
cpp_smoothLinLog

Smooth LinLog Transformation with Rcpp
cpp_v_int64_to_uint64

Vectorize Int64 to Uint64 64bits Conversion
cpp_transform

Matrix Transformation
data_add_features

Add Feature to IFC_data Object
cpp_getoffsets_wid

IFC_offsets Computation with Object Identification
cpp_uint32_to_raw

Uint32 to Raw Conversion
cpp_writeBMP

BMP Writer
buildBatch

Batch Builder
cpp_replace_non_finite

Non Finite Values Replacement
cpp_group_df

Data Frame Merge Groups with Rcpp
fastCbind

Combine by Columns
cpp_fast_sample

Use Rcpp for Sampling
data_add_regions

Add Region to IFC_data Object
data_add_pops

Add Population to IFC_data Object
cpp_coord_to_px

Coordinates to Pixels
cpp_rawdecomp

IFC_object Decompression to RAW
densCols

Colors for Smooth Density Plots
cpp_getTAGS

IFD Tags Extraction
endPB

Progress Bar Terminator
fromXML2_gating

GatingML Conversion from XML2
formatn

File Path Placeholders Formatting
cpp_get_bytes_order

Get Bytes Order
cpp_getoffsets_noid

IFC_offsets Computation without Id Determination
getOffsets

RIF/CIF File Image Field Directories Offsets Extraction
getLuminance

Luminance Computation
cpp_raster

Raster Image
cpp_pnt_in_gate

Point in Gate
get_coordmap_adjusted

Device Adjusted Coordinates
mergeXIF

RIF/CIF File Merging
cpp_uint64_to_int64

Uint64 to Int64 64bits Conversion
modifyGamma

Image Gamma Modification
popsRename

Populations Renaming
paletteIFC

R/IDEAS Color Palette Mapping
objectWrite

Object File Export
cpp_ell_coord

Ellipse Boundaries to Coordinates
cpp_checksum

Checksum for RIF/CIF
cpp_cleanse

Matrix Cleanser
cpp_draw

Draw Shape to Image
cpp_v_int32_to_uint32

Vectorize Int32 to Uint32 32bits Conversion
popsRetrieveGraph

Graph Retrieval from Graphical IFC_pops
protectn

Name Protection
random_name

Random Name Generator
get_ylim

Histogram y-Axis Limits Constructor
get_coordmap_raw

Device Raw Coordinates
feature_namer

Feature Default Name Computation
objectTransform

Object Transformation
objectResize

Object Resizing
getASSIST

ASSIST Database Extraction
getAborted

Aborted Batch Files Retrieval
inv_smoothAsinh

Inverse Smooth Asinh Transformation
objectCleanse

Object Cleanser
inv_colConv

Hexadecimal to Integer Color Conversion
expand_list

XML Node List Expansion
escape_entities

XML Entities Protection
redefine_features_def_feat

IFC_features_def Feature Redefinition
data_rm_regions

Remove Region from an IFC_data Object
data_add_pop_sample

Population Sampling
data_to_DAF

DAF File Writer
getFileExt

File Extension Retrieval
smoothLinLog

Smooth LinLog Transformation
redefine_features_def_msk_img

IFC_features_def Mask or Image Redefinition
cpp_fast_range

Use Rcpp for Range
cpp_fast_rowAny

Use Rcpp to Apply Any on Matrix Rows
popsCompute

IFC_pops Computation
rasterplot

Fast 2D plot
readFCS

FCS File Parser
popsCopy

Copy Populations from One File to Another File
popsGetObjectsIds

IFC_pops Object Numbers
getIFD

RIF/CIF Image Field Directories Extraction
popsGetSiblings

IFC_pops Sibling Population Identification
group

Groups Combination
getImagesValues

RIF/CIF Image Values Extraction
objectColorize

Object Colorizer
getFullTag

Image Field Directory Full Tag Retrieval
toXML2_graphs

IFC_graphs XML Conversion
pan_key

Lattice Key Panel Contructor
toXML2_graphpop_gs

Graphical Population GatingML Conversion to XML2
specialr

Special Character Replacement
parseFCSname

FCS Name Parser
pan_smooth

Histogram Smooth Constructor
hist_constr

Histogram Constructor
pan_hist

Lattice Histogram Panel Contructor
writeIFD

Image Field Directory Writer
map_color

Color Mapping
map_style

Style Mapping
objectNormalize

Object Intensity Normalization
objectParam

Object Extraction Parameters Definition
cpp_mask

Equal Sized Matrix to Matrix Writer According to Mask
cpp_resize

Matrix Resizing
cpp_scanFirst

File Scanner
extractStats

Statistics Extraction
data_rm_features

Remove Features from an IFC_data Object
cpp_normalize

Matrix Normalization
data_rm_pops

Remove Population from an IFC_data Object
myScales

Scale Constructor for IFC Graphs Plotting
xml_new_node

List to XML Conversion
switch_channel

IFC_data Channel Swap
popsWithin

IFC_pops Checker for Object Membership to Populations
rev_string

Reverse String
remove_ext

File Extension Removal
pow2

Power of Two
plot_raster

`IFC_plot` Conversion to 'raster' Plot
fastAny

Any with Rcpp
inv_smoothLinLog

Inverse Smooth LinLog Transformation
plot_stats

`IFC_plot` Statistics Extraction
newPB

Progress Bar Initializer
objectDisplay

Object Display
popsNetwork

IFC_pops Network Display
popsOrderNodes

IFC_pops Population Level Ordering
next_bool

Next Component Prediction
layoutReport

Report Layout Extraction
trunc_string

String Truncation
to_xml_list

List to XML Node Conversion
testXIF

RIF/CIF Image Order Test
toXML2_features

IFC_features XML Conversion
toXML2_features_def

IFC_features_def XML Conversion
texttomatrix

Text to Image Conversion
redefine_masks

IFC_masks Redefinition
num_to_string

Numeric to String Formatting
toXML2_regions

IFC_regions XML Conversion
toBIN_features

IFC_features Raw Conversion
writeIFC

IFC Files Generic Writer
writeGatingStrategy

Gating Strategy File Writer
toXML2_spillover_gs

Spillover GatingML Conversion
redefine_masks_image

IFC_masks Image Redefinition
plot_base

`IFC_plot` Conversion to 'base' Plot
plot_lattice

`IFC_plot` Conversion to 'lattice' Plot
popsGetAffiliation

IFC_pops Affiliation Finder
objectExtract

Object Extraction
plotGraph

Plot and Stats Computation for IFC Graph
readGatingStrategy

Gating Strategy File Reader
parseTrans

Parse Transformation Information
readGatingML

GatingML File Reader
popsGetLevels

IFC_pops Levels Dependency Determination
redefine_masks_mask

IFC_masks Mask Redefinition
redefine_obj

IFC_data Redefinition
toBIN_images

IFC_images Raw Conversion
toXML2_masks

IFC_masks XML Conversion
toCapFirstOnly

First Letter Only Capitalization
statsCompute

IFC_stats Computation
splitp

String Decomposition with Placeholders
splitf

File Path Decomposition
readIFC

IFC Files Generic Reader
popsGetSiblings1

IFC_pops Sibling Population from Same Base Identification
popsGetSiblings2

IFC_pops Sibling Population from Same Region Identification
validate_bool

Boolean Expression Validation
toXML2_pops

IFC_pops XML Conversion
smoothAsinh

Smooth Asinh Transformation
subsetOffsets

IFC_offset Subsetting
setPB

Progress Bar Updater
redefine_features_def

IFC_features_def Redefinition
subsetXIF

RIF/CIF File Subsetting
whoami

Input Identification
toXML2_images

IFC_images XML Conversion
toXML2_graphs_gs

IFC_graphs GatingML Conversion
usedefault_obj

IFC_data Default Naming
toXML2_boolpop_gs

Boolean Population GatingML Conversion to XML2
splitn

String Decomposition with Operators
toEllipse

Ellipsoid Polygon Constructor
tryReportFileCreation

Report File Creation
toXML2_stats

IFC_stats XML Conversion
to_list_node

XML Node to List Conversion
type_constr

Histogram Type Constructor
val_constr

Histogram Val Constructor