Package: opendp 0.15.1

Stefano Iacus

opendp: R Bindings for the OpenDP Library

The OpenDP Library is a modular collection of statistical algorithms that adhere to the definition of differential privacy. It can be used to build applications of privacy-preserving computations, using a number of different models of privacy.

Authors:Stefano Iacus [cre], The OpenDP Project [aut], The authors of the dependency Rust crates [ctb]

opendp_0.15.1.tar.gz
opendp_0.15.1.zip(r-4.7)opendp_0.15.1.zip(r-4.6)opendp_0.15.1.zip(r-4.5)
opendp_0.15.1.tgz(r-4.6-x86_64)opendp_0.15.1.tgz(r-4.6-arm64)opendp_0.15.1.tgz(r-4.5-x86_64)opendp_0.15.1.tgz(r-4.5-arm64)
opendp_0.15.1.tar.gz(r-4.7-arm64)opendp_0.15.1.tar.gz(r-4.7-x86_64)opendp_0.15.1.tar.gz(r-4.6-arm64)opendp_0.15.1.tar.gz(r-4.6-x86_64)
manual.pdf |manual.html
card.svg |card.png
opendp/json (API)

# Install 'opendp' in R:
install.packages('opendp', repos = c('https://opendp.r-universe.dev', 'https://cloud.r-project.org'))

Bug tracker:https://github.com/opendp/opendp/issues

On CRAN:

Conda:

differential-privacydp-programming-frameworkopendpprivacyrustcargo

6.21 score 421 stars 32 scripts 276 exports 0 dependencies

Last updated from:ecd1e07cfe (on r-universe). Checks:4 NOTE, 1 OK, 7 WARNING, 1 FAIL. Indexed: yes.

TargetResultTimeFilesSyslog
linux-devel-arm64NOTE487
linux-devel-x86_64NOTE498
source / vignettesOK567
linux-release-arm64NOTE479
linux-release-x86_64NOTE497
macos-release-arm64WARNING413
macos-release-x86_64WARNING1583
macos-oldrel-arm64WARNING374
macos-oldrel-x86_64WARNING1280
windows-develWARNING1675
windows-releaseWARNING1734
windows-oldrelWARNING1725
wasm-releaseFAIL466

Exports:absolute_distanceaccuracy_to_discrete_gaussian_scaleaccuracy_to_discrete_laplacian_scaleaccuracy_to_gaussian_scaleaccuracy_to_laplacian_scaleapproximateatom_domainbinary_searchbinary_search_chainbinary_search_paramBitVectorbitvector_domainboolchange_one_distancechoose_branching_factordisable_featuresdiscrete_distancediscrete_gaussian_scale_to_accuracydiscrete_laplacian_scale_to_accuracydomain_carrier_typedomain_debugdomain_typeenable_featuresExtrinsicObjectf32f64fixed_smoothed_max_divergencefunction_evalgaussian_scale_to_accuracyhamming_distancehashitemsi128i16i32i64i8insert_delete_distancel01inf_distancel02inf_distancel1_distancel2_distancelaplacian_scale_to_accuracylinf_distancemake_adaptive_compositionmake_alp_queryablemake_approximatemake_b_ary_treemake_basic_compositionmake_bounded_float_checked_summake_bounded_float_ordered_summake_bounded_int_monotonic_summake_bounded_int_ordered_summake_bounded_int_split_summake_canonical_noisemake_castmake_cast_defaultmake_cast_inherentmake_cdfmake_chain_mtmake_chain_pmmake_chain_ttmake_clampmake_compositionmake_consistent_b_ary_treemake_countmake_count_bymake_count_by_categoriesmake_count_distinctmake_create_dataframemake_df_cast_defaultmake_df_is_equalmake_drop_nullmake_findmake_find_binmake_fix_deltamake_fixed_approxDP_to_approxDPmake_fully_adaptive_compositionmake_gaussianmake_gaussian_thresholdmake_geometricmake_identitymake_impute_constantmake_impute_uniform_floatmake_indexmake_is_equalmake_is_nullmake_laplacemake_laplace_thresholdmake_lipschitz_float_mulmake_meanmake_metric_boundedmake_metric_unboundedmake_noisemake_noise_thresholdmake_noisy_maxmake_noisy_top_kmake_ordered_randommake_population_amplificationmake_privacy_filtermake_private_quantilemake_pureDP_to_zCDPmake_quantile_score_candidatesmake_quantiles_from_countsmake_randomized_responsemake_randomized_response_bitvecmake_randomized_response_boolmake_report_noisy_max_gumbelmake_resizemake_select_columnmake_select_private_candidatemake_sequential_compositionmake_sized_bounded_float_checked_summake_sized_bounded_float_ordered_summake_sized_bounded_int_checked_summake_sized_bounded_int_monotonic_summake_sized_bounded_int_ordered_summake_sized_bounded_int_split_summake_split_dataframemake_split_linesmake_split_recordsmake_subset_bymake_summake_sum_of_squared_deviationsmake_unorderedmake_user_measurementmake_user_transformationmake_variancemake_zCDP_to_approxDPmap_domainmax_divergencemeasure_debugmeasure_distance_typemeasure_typemeasurement_checkmeasurement_functionmeasurement_input_carrier_typemeasurement_input_distance_typemeasurement_input_domainmeasurement_input_metricmeasurement_invokemeasurement_mapmeasurement_output_distance_typemeasurement_output_measuremetric_debugmetric_distance_typemetric_typenew_functionnew_hashtabnew_privacy_profilenew_queryableodometer_input_carrier_typeodometer_input_domainodometer_input_metricodometer_invokeodometer_output_measureodometer_queryable_invokeodometer_queryable_invoke_typeodometer_queryable_privacy_lossodometer_queryable_privacy_loss_typeoption_domainqueryable_evalqueryable_query_typerenyi_divergencesmoothed_max_divergenceStringsymmetric_distancethen_adaptive_compositionthen_alp_queryablethen_approximatethen_b_ary_treethen_basic_compositionthen_bounded_float_checked_sumthen_bounded_float_ordered_sumthen_bounded_int_monotonic_sumthen_bounded_int_ordered_sumthen_bounded_int_split_sumthen_canonical_noisethen_castthen_cast_defaultthen_cast_inherentthen_cdfthen_chain_mtthen_chain_pmthen_chain_ttthen_clampthen_compositionthen_consistent_b_ary_treethen_countthen_count_bythen_count_by_categoriesthen_count_distinctthen_create_dataframethen_df_cast_defaultthen_df_is_equalthen_drop_nullthen_findthen_find_binthen_fix_deltathen_fixed_approxDP_to_approxDPthen_fully_adaptive_compositionthen_gaussianthen_gaussian_thresholdthen_geometricthen_identitythen_impute_constantthen_impute_uniform_floatthen_indexthen_is_equalthen_is_nullthen_laplacethen_laplace_thresholdthen_lipschitz_float_multhen_meanthen_metric_boundedthen_metric_unboundedthen_noisethen_noise_thresholdthen_noisy_maxthen_noisy_top_kthen_ordered_randomthen_population_amplificationthen_postprocessthen_privacy_filterthen_private_quantilethen_pureDP_to_zCDPthen_quantile_score_candidatesthen_quantiles_from_countsthen_randomized_responsethen_randomized_response_bitvecthen_randomized_response_boolthen_report_noisy_max_gumbelthen_resizethen_select_columnthen_select_private_candidatethen_sequential_compositionthen_sized_bounded_float_checked_sumthen_sized_bounded_float_ordered_sumthen_sized_bounded_int_checked_sumthen_sized_bounded_int_monotonic_sumthen_sized_bounded_int_ordered_sumthen_sized_bounded_int_split_sumthen_split_dataframethen_split_linesthen_split_recordsthen_subset_bythen_sumthen_sum_of_squared_deviationsthen_unorderedthen_user_measurementthen_user_transformationthen_variancethen_zCDP_to_approxDPto_str.defaultto_thentransformation_checktransformation_functiontransformation_input_carrier_typetransformation_input_distance_typetransformation_input_domaintransformation_input_metrictransformation_invoketransformation_maptransformation_output_distance_typetransformation_output_domaintransformation_output_metricu128u16u32u64u8user_distanceuser_divergenceuser_domainusizevector_domainzero_concentrated_divergence

Dependencies:

Readme and manuals

Help Manual

Help pageTopics
Construct an instance of the 'AbsoluteDistance' metric.absolute_distance
Convert a desired 'accuracy' (tolerance) into a discrete gaussian noise scale at a statistical significance level 'alpha'.accuracy_to_discrete_gaussian_scale
Convert a desired 'accuracy' (tolerance) into a discrete Laplacian noise scale at a statistical significance level 'alpha'.accuracy_to_discrete_laplacian_scale
Convert a desired 'accuracy' (tolerance) into a gaussian noise scale at a statistical significance level 'alpha'.accuracy_to_gaussian_scale
Convert a desired 'accuracy' (tolerance) into a Laplacian noise scale at a statistical significance level 'alpha'.accuracy_to_laplacian_scale
Privacy measure used to define delta-approximate PM-differential privacy.approximate
Construct an instance of 'AtomDomain'.atom_domain
Find the closest passing value to the decision boundary of 'predicate'binary_search
Find the highest-utility ('d_in', 'd_out')-close Transformation or Measurement.binary_search_chain
Solve for the ideal constructor argument to 'make_chain'binary_search_param
type signature for a BitVectorBitVector
Construct an instance of 'BitVectorDomain'.bitvector_domain
type signature for a booleanbool
Construct an instance of the 'ChangeOneDistance' metric.change_one_distance
Returns an approximation to the ideal 'branching_factor' for a dataset of a given size, that minimizes error in cdf and quantile estimates based on b-ary trees.choose_branching_factor
Disable features in the opendp package.disable_features
Construct an instance of the 'DiscreteDistance' metric.discrete_distance
Convert a discrete gaussian scale into an accuracy estimate (tolerance) at a statistical significance level 'alpha'.discrete_gaussian_scale_to_accuracy
Convert a discrete Laplacian scale into an accuracy estimate (tolerance) at a statistical significance level 'alpha'.discrete_laplacian_scale_to_accuracy
Get the carrier type of a 'domain'.domain_carrier_type
Debug a 'domain'.domain_debug
Get the type of a 'domain'.domain_type
Enable features for the opendp package.enable_features
type signature for an arbitrary R object preserved across FFIExtrinsicObject
type signature for a 32-bit floating point numberf32
type signature for a 64-bit floating point numberf64
Privacy measure used to define (epsilon, delta)-approximate differential privacy.fixed_smoothed_max_divergence
Eval the 'function' with 'arg'.function_eval
Convert a gaussian scale into an accuracy estimate (tolerance) at a statistical significance level 'alpha'.gaussian_scale_to_accuracy
Construct an instance of the 'HammingDistance' metric.hamming_distance
extract heterogeneously typed keys and values from a hashtabhashitems
type signature for a 128-bit signed integeri128
type signature for a 16-bit signed integeri16
type signature for a 32-bit signed integeri32
type signature for a 64-bit signed integeri64
type signature for an 8-bit signed integeri8
Construct an instance of the 'InsertDeleteDistance' metric.insert_delete_distance
Construct an instance of the 'L01InfDistance' metric.l01inf_distance
Construct an instance of the 'L02InfDistance' metric.l02inf_distance
Construct an instance of the 'L1Distance' metric.l1_distance
Construct an instance of the 'L2Distance' metric.l2_distance
Convert a Laplacian scale into an accuracy estimate (tolerance) at a statistical significance level 'alpha'.laplacian_scale_to_accuracy
Construct an instance of the 'LInfDistance' metric.linf_distance
adaptive composition constructormake_adaptive_composition
alp queryable constructormake_alp_queryable
approximate constructormake_approximate
b ary tree constructormake_b_ary_tree
basic composition constructormake_basic_composition
bounded float checked sum constructormake_bounded_float_checked_sum
bounded float ordered sum constructormake_bounded_float_ordered_sum
bounded int monotonic sum constructormake_bounded_int_monotonic_sum
bounded int ordered sum constructormake_bounded_int_ordered_sum
bounded int split sum constructormake_bounded_int_split_sum
canonical noise constructormake_canonical_noise
cast constructormake_cast
cast default constructormake_cast_default
cast inherent constructormake_cast_inherent
cdf constructormake_cdf
chain mt constructormake_chain_mt
chain pm constructormake_chain_pm
chain tt constructormake_chain_tt
clamp constructormake_clamp
composition constructormake_composition
consistent b ary tree constructormake_consistent_b_ary_tree
count constructormake_count
count by constructormake_count_by
count by categories constructormake_count_by_categories
count distinct constructormake_count_distinct
create dataframe constructormake_create_dataframe
df cast default constructormake_df_cast_default
df is equal constructormake_df_is_equal
drop null constructormake_drop_null
find constructormake_find
find bin constructormake_find_bin
fix delta constructormake_fix_delta
fixed approxDP to approxDP constructormake_fixed_approxDP_to_approxDP
fully adaptive composition constructormake_fully_adaptive_composition
gaussian constructormake_gaussian
gaussian threshold constructormake_gaussian_threshold
geometric constructormake_geometric
identity constructormake_identity
impute constant constructormake_impute_constant
impute uniform float constructormake_impute_uniform_float
index constructormake_index
is equal constructormake_is_equal
is null constructormake_is_null
laplace constructormake_laplace
laplace threshold constructormake_laplace_threshold
lipschitz float mul constructormake_lipschitz_float_mul
mean constructormake_mean
metric bounded constructormake_metric_bounded
metric unbounded constructormake_metric_unbounded
noise constructormake_noise
noise threshold constructormake_noise_threshold
noisy max constructormake_noisy_max
noisy top k constructormake_noisy_top_k
ordered random constructormake_ordered_random
population amplification constructormake_population_amplification
privacy filter constructormake_privacy_filter
private quantile constructormake_private_quantile
pureDP to zCDP constructormake_pureDP_to_zCDP
quantile score candidates constructormake_quantile_score_candidates
quantiles from counts constructormake_quantiles_from_counts
randomized response constructormake_randomized_response
randomized response bitvec constructormake_randomized_response_bitvec
randomized response bool constructormake_randomized_response_bool
report noisy max gumbel constructormake_report_noisy_max_gumbel
resize constructormake_resize
select column constructormake_select_column
select private candidate constructormake_select_private_candidate
sequential composition constructormake_sequential_composition
sized bounded float checked sum constructormake_sized_bounded_float_checked_sum
sized bounded float ordered sum constructormake_sized_bounded_float_ordered_sum
sized bounded int checked sum constructormake_sized_bounded_int_checked_sum
sized bounded int monotonic sum constructormake_sized_bounded_int_monotonic_sum
sized bounded int ordered sum constructormake_sized_bounded_int_ordered_sum
sized bounded int split sum constructormake_sized_bounded_int_split_sum
split dataframe constructormake_split_dataframe
split lines constructormake_split_lines
split records constructormake_split_records
subset by constructormake_subset_by
sum constructormake_sum
sum of squared deviations constructormake_sum_of_squared_deviations
unordered constructormake_unordered
user measurement constructormake_user_measurement
user transformation constructormake_user_transformation
variance constructormake_variance
zCDP to approxDP constructormake_zCDP_to_approxDP
Construct an instance of 'MapDomain'.map_domain
Privacy measure used to define epsilon-pure differential privacy.max_divergence
Debug a 'measure'.measure_debug
Get the distance type of a 'measure'.measure_distance_type
Get the type of a 'measure'.measure_type
Check the privacy relation of the 'measurement' at the given 'd_in', 'd_out'measurement_check
Get the function from a measurement.measurement_function
Get the input (carrier) data type of 'this'.measurement_input_carrier_type
Get the input distance type of 'measurement'.measurement_input_distance_type
Get the input domain from a 'measurement'.measurement_input_domain
Get the input domain from a 'measurement'.measurement_input_metric
Invoke the 'measurement' with 'arg'. Returns a differentially private release.measurement_invoke
Use the 'measurement' to map a given 'd_in' to 'd_out'.measurement_map
Get the output distance type of 'measurement'.measurement_output_distance_type
Get the output domain from a 'measurement'.measurement_output_measure
Debug a 'metric'.metric_debug
Get the distance type of a 'metric'.metric_distance_type
Get the type of a 'metric'.metric_type
new domainnew_domain
Construct a Function from a user-defined callback. Can be used to build a postprocessor.new_function
new functionnew_function_internal
create an instance of a hashtab from keys and valuesnew_hashtab
new measurenew_measure
new measurementnew_measurement
new metricnew_metric
new odometernew_odometer
new odometer queryablenew_odometer_queryable_internal
Construct a PrivacyProfile from a user-defined callback.new_privacy_profile
new privacy profilenew_privacy_profile_internal
Construct a queryable from a user-defined transition function.new_queryable
new queryablenew_queryable_internal
new transformationnew_transformation
Internal function. Retrieve the type descriptor string of an AnyObject.object_type
Get the input (carrier) data type of 'this'.odometer_input_carrier_type
Get the input domain from a 'odometer'.odometer_input_domain
Get the input domain from a 'odometer'.odometer_input_metric
Invoke the 'odometer' with 'arg'. Returns a differentially private release.odometer_invoke
Get the output domain from a 'odometer'.odometer_output_measure
Eval the odometer 'queryable' with an invoke 'query'.odometer_queryable_invoke
Get the invoke query type of an odometer 'queryable'.odometer_queryable_invoke_type
Retrieve the privacy loss of an odometer 'queryable'.odometer_queryable_privacy_loss
Get the map query type of an odometer 'queryable'.odometer_queryable_privacy_loss_type
OpenDP R Bindingsopendp-package opendp
Construct an instance of 'OptionDomain'.option_domain
Parse a runtime type or infer it from an exampleparse_or_infer
Internal function. Use a PrivacyProfile to find epsilon at a given 'epsilon'.privacy_profile_delta
Internal function. Use an PrivacyProfile to find epsilon at a given 'delta'.privacy_profile_epsilon
Eval the 'queryable' with 'query'. Returns a differentially private release.queryable_eval
Get the query type of 'queryable'.queryable_query_type
Privacy measure used to define epsilon(alpha)-Rényi differential privacy.renyi_divergence
Infer a runtime type from a public examplert_infer
Parse a runtime type descriptor into a runtime_type objectrt_parse
Privacy measure used to define epsilon(delta)-approximate differential privacy.smoothed_max_divergence
type signature for a stringString
Construct an instance of the 'SymmetricDistance' metric.symmetric_distance
partial adaptive composition constructorthen_adaptive_composition
partial alp queryable constructorthen_alp_queryable
partial approximate constructorthen_approximate
partial b ary tree constructorthen_b_ary_tree
partial basic composition constructorthen_basic_composition
partial bounded float checked sum constructorthen_bounded_float_checked_sum
partial bounded float ordered sum constructorthen_bounded_float_ordered_sum
partial bounded int monotonic sum constructorthen_bounded_int_monotonic_sum
partial bounded int ordered sum constructorthen_bounded_int_ordered_sum
partial bounded int split sum constructorthen_bounded_int_split_sum
partial canonical noise constructorthen_canonical_noise
partial cast constructorthen_cast
partial cast default constructorthen_cast_default
partial cast inherent constructorthen_cast_inherent
partial cdf constructorthen_cdf
partial chain mt constructorthen_chain_mt
partial chain pm constructorthen_chain_pm
partial chain tt constructorthen_chain_tt
partial clamp constructorthen_clamp
partial composition constructorthen_composition
partial consistent b ary tree constructorthen_consistent_b_ary_tree
partial count constructorthen_count
partial count by constructorthen_count_by
partial count by categories constructorthen_count_by_categories
partial count distinct constructorthen_count_distinct
partial create dataframe constructorthen_create_dataframe
partial df cast default constructorthen_df_cast_default
partial df is equal constructorthen_df_is_equal
partial drop null constructorthen_drop_null
partial find constructorthen_find
partial find bin constructorthen_find_bin
partial fix delta constructorthen_fix_delta
partial fixed approxDP to approxDP constructorthen_fixed_approxDP_to_approxDP
partial fully adaptive composition constructorthen_fully_adaptive_composition
partial gaussian constructorthen_gaussian
partial gaussian threshold constructorthen_gaussian_threshold
partial geometric constructorthen_geometric
partial identity constructorthen_identity
partial impute constant constructorthen_impute_constant
partial impute uniform float constructorthen_impute_uniform_float
partial index constructorthen_index
partial is equal constructorthen_is_equal
partial is null constructorthen_is_null
partial laplace constructorthen_laplace
partial laplace threshold constructorthen_laplace_threshold
partial lipschitz float mul constructorthen_lipschitz_float_mul
partial mean constructorthen_mean
partial metric bounded constructorthen_metric_bounded
partial metric unbounded constructorthen_metric_unbounded
partial noise constructorthen_noise
partial noise threshold constructorthen_noise_threshold
partial noisy max constructorthen_noisy_max
partial noisy top k constructorthen_noisy_top_k
partial ordered random constructorthen_ordered_random
partial population amplification constructorthen_population_amplification
Compose a measurement with a postprocessing function.then_postprocess
partial privacy filter constructorthen_privacy_filter
partial private quantile constructorthen_private_quantile
partial pureDP to zCDP constructorthen_pureDP_to_zCDP
partial quantile score candidates constructorthen_quantile_score_candidates
partial quantiles from counts constructorthen_quantiles_from_counts
partial randomized response constructorthen_randomized_response
partial randomized response bitvec constructorthen_randomized_response_bitvec
partial randomized response bool constructorthen_randomized_response_bool
partial report noisy max gumbel constructorthen_report_noisy_max_gumbel
partial resize constructorthen_resize
partial select column constructorthen_select_column
partial select private candidate constructorthen_select_private_candidate
partial sequential composition constructorthen_sequential_composition
partial sized bounded float checked sum constructorthen_sized_bounded_float_checked_sum
partial sized bounded float ordered sum constructorthen_sized_bounded_float_ordered_sum
partial sized bounded int checked sum constructorthen_sized_bounded_int_checked_sum
partial sized bounded int monotonic sum constructorthen_sized_bounded_int_monotonic_sum
partial sized bounded int ordered sum constructorthen_sized_bounded_int_ordered_sum
partial sized bounded int split sum constructorthen_sized_bounded_int_split_sum
partial split dataframe constructorthen_split_dataframe
partial split lines constructorthen_split_lines
partial split records constructorthen_split_records
partial subset by constructorthen_subset_by
partial sum constructorthen_sum
partial sum of squared deviations constructorthen_sum_of_squared_deviations
partial unordered constructorthen_unordered
partial user measurement constructorthen_user_measurement
partial user transformation constructorthen_user_transformation
partial variance constructorthen_variance
partial zCDP to approxDP constructorthen_zCDP_to_approxDP
Convert a format-able value to a string representationto_str.default
Convert hashtab to a string representationto_str.hashtab
Convert a 'make_' constructor into a 'then_' constructor.to_then
Check the privacy relation of the 'measurement' at the given 'd_in', 'd_out'transformation_check
Get the function from a transformation.transformation_function
Get the input (carrier) data type of 'this'.transformation_input_carrier_type
Get the input distance type of 'transformation'.transformation_input_distance_type
Get the input domain from a 'transformation'.transformation_input_domain
Get the input domain from a 'transformation'.transformation_input_metric
Invoke the 'transformation' with 'arg'. Returns a differentially private release.transformation_invoke
Use the 'transformation' to map a given 'd_in' to 'd_out'.transformation_map
Get the output distance type of 'transformation'.transformation_output_distance_type
Get the output domain from a 'transformation'.transformation_output_domain
Get the output domain from a 'transformation'.transformation_output_metric
type signature for a 128-bit unsigned integeru128
type signature for a 16-bit unsigned integeru16
type signature for a 32-bit unsigned integeru32
type signature for a 64-bit unsigned integeru64
type signature for an 8-bit unsigned integeru8
Construct a new UserDistance. Any two instances of an UserDistance are equal if their string descriptors are equal.user_distance
Privacy measure with meaning defined by an OpenDP Library user (you).user_divergence
Construct a new UserDomain. Any two instances of an UserDomain are equal if their string descriptors are equal. Contains a function used to check if any value is a member of the domain.user_domain
type signature for a pointer-sized unsigned integerusize
Construct an instance of 'VectorDomain'.vector_domain
Privacy measure used to define rho-zero concentrated differential privacy.zero_concentrated_divergence