Man pages for JosepER/lissyrtools
Tools for LISSY Jobs
| add_leading_0s | Add leading 0s |
| add_unique_ids | Add unique ID variables when binding LIS or LWS files. |
| all.is.numeric | Check if all elements in a vector are numeric |
| all.values.equal | All values are equal \lifecycleexperimental |
| apply_iqr_top_bottom_coding | Apply IQR-Based Top and Bottom Coding to LIS/LWS Variables |
| apply_oecd_equivalisation | Apply OECD Equivalence Scale to a Variable |
| apply_ppp_adjustment | Adjust Monetary Variables for Inflation and PPP |
| apply_sqrt_equivalisation | Apply Square-Root Equivalisation to a Variable |
| bind_lissy_files | Bind multiple LIS or LWS datasets |
| ccyy_to_cname | Get the country name from the 'ccyy" |
| ccyy_to_yyyy | Get the year from the 'ccyy" |
| change_file_name_format | Change the format of a file name |
| check_file_lists_contain_same_datasets | Checks if two lists have the same datasets |
| check_input_in_weight_argument | Validate the Weight Variable Input |
| check_missing_share | Checks the share of missing values for each column acroos a... |
| checks_compute_functions | Perform checks for 'compute' functions. |
| check_variable_level | Checks if the variable is 'household' or 'person' level. |
| compute_atkinson | Compute Atkinson index. |
| compute_gini | Compute gini index. |
| compute_mean | Compute standard indicators. |
| compute_percentiles | Compute percentiles. |
| compute_poverty_rate | Compute poverty rate. |
| compute_weighted_count | Compute (Weighted) Counts or Percentages for a Categorical... |
| compute_weighted_mean | Compute (Weighted) Means for a Variable |
| compute_weighted_percentiles | Compute Weighted Percentiles or Share of Distribution |
| convert_list_from_ccyy_to_cc_names_yyyy | Rearranges a list whose elements are ccyy's into country... |
| database_character_to_name | Converts 'i', 'w', 'e' into 'LIS', 'LWS' 'ERFLIS' |
| datasets | LIS and LWS datasets |
| data_vars_labels | Variable labels |
| data_with_warnings | Variable notes |
| decide_plot_type | Decide plot type based on input data frame |
| define_option | Define an option |
| deflators | CPI and PPP deflators. |
| determine_file_level | Determine the level of the file |
| determine_weight | Determine the name of the weight variable |
| extend_breaks_min_and_max | Extend the minimum and maximum of a vector used for breaks |
| extract_information_from_file_name | Extract information from file name |
| four_digit_year | Compute four digit year from two digit one. |
| get_countries_lis | Print all the country code in LIS |
| get_countries_lws | Print all the country code in LWS |
| get_database | Get the database from a list of files |
| get_directory | Get directory from parameters file |
| get_file_lisppp | Retreive the 'lisppp' deflator for a given file and variable. |
| get_index_hh_heads | Get the index of hh-heads |
| get_lissy_attributes | Get the lissy attributes |
| get_lws_file_income_reference_year | Retrieve the reference year for LWS files |
| get_surveys_lis | Print the survey used to construct the LIS datasets for a... |
| get_surveys_lws | Print the survey used to construct the LWS datasets for a... |
| get_years_lis | Print all the existing years in LIS for a given country. |
| get_years_lws | Print all the existing years in LWS for a given country. |
| has_lissy_attributes | A list with lissy attributes |
| implement_adjust_by_lisppp | Applies the deflator adjustment to an aggregate |
| implement_equivalise | Apply equivalise by number of household members |
| implement_equivalise_oecd | Apply equivalise with the OECD scale |
| implement_false_zeros_to_na | Apply the recoding of zeros into missing values if all values... |
| implement_filter_age | Apply 'transform_filter_age()' to a single file |
| implement_negative_values_to_zero | Apply recoding negative values to zero |
| implement_restrict_age | Apply 'transform_restrict_age()' to a single file |
| implement_restrict_to_household_heads | Apply 'transform_restrict_to_household_heads()' to a single... |
| implement_top_code_with_iqr | Apply top or bottom coding with log IQR to a single file |
| implement_top_code_with_iqr_pfile | Apply top and bottom coding with log IQR to a level-defined... |
| implement_zeros_to_na | Apply recoding of zeros into missing values |
| import_lisppp_data | Import lisppp dataset |
| intervals_with_single_value | Interval has single value |
| iqr_top_bottom_coding | IQR-Based Top/Bottom Coding for a Single Variable |
| is.all.na.or.zero | Test if all objects are NAs or 0 |
| is.all.same.value | Test if all elements of a vector have the same value |
| is_change_possible | Is possible to produce the desired format change |
| is.household.dataset | Checks if the dataset is at household level |
| is_lissy_machine | Is a LISSY machine |
| it14_h_lis | Sample Household-Level LIS Dataset - Italy 2014 |
| it14_h_lws | Sample Household-Level LWS Dataset - Italy 2014 |
| it14_p_lis | Sample Individual-Level LIS Dataset - Italy 2014 |
| it14_p_lws | Sample Individual-Level LWS Dataset - Italy 2014 |
| it16_h_lis | Sample Household-Level LIS Dataset - Italy 2016 |
| it16_h_lws | Sample Household-Level LWS Dataset - Italy 2016 |
| it16_p_lis | Sample Individual-Level LIS Dataset - Italy 2016 |
| it16_p_lws | Sample Individual-Level LWS Dataset - Italy 2016 |
| it20_h_lis | Sample Household-Level LIS Dataset - Italy 2020 |
| it20_p_lis | Sample Individual-Level LIS Dataset - Italy 2020 |
| lissy_map | Wrap over 'purrr::imap()' for lissy files |
| lissyrtools | lissyrtools: Functions that can be used within LISSY |
| lissyuse | Load data easily and efficiently with lissyuse |
| lis_variables | LIS Variables |
| lws_variables | LWS Variables |
| merge_dataset_levels | Merge household and person-level files |
| merge_lis_dataset_levels | Merges a hfile with its pfile |
| missing_or_zero_vars_all | Variable Status Data Frame |
| missing_values_in_variable_warning | Missing values in variable warning |
| mx14_h_lis | Sample Household-Level LIS Dataset - Mexico 2014 |
| mx14_p_lis | Sample Individual-Level LIS Dataset - Mexico 2014 |
| mx16_h_lis | Sample Household-Level LIS Dataset - Mexico 2016 |
| mx16_p_lis | Sample Individual-Level LIS Dataset - Mexico 2016 |
| mx18_h_lis | Sample Household-Level LIS Dataset - Mexico 2018 |
| mx18_p_lis | Sample Individual-Level LIS Dataset - Mexico 2018 |
| n_numbers_smaller | Number of elements smaller than input |
| paste_lissy_attributes | Paste lissy attributes |
| pipe | Pipe operator |
| plot_bar | Plot an indicator using a bar plot. |
| plot_indicator | Plot an Indicator. |
| plot_line | Plot an indicator using a line plot. |
| print_all_lissy_files | Print all available files |
| print_atkinson | Print the Atkinson Index |
| print_gini | Print the Gini Coefficient |
| print_indicator | Print an indicator |
| print_percentiles | Print percentiles. |
| print_ratio | Print the Ratio Index |
| read_file_name_format | Read the format of a file name |
| read_format_names | Read the format of files argument |
| read_LIS | Read LIS |
| read_lissy_files | Read files in LISSY |
| read_lissy_files_locally | Read files locally |
| read_rename_files | Rename read files |
| remove_dname_with_missings_in_weights | Is Canada LWS on the loaded data ? |
| retrieve_database_from_directory | Get the database from a directory string |
| retrieve_names_key_variables | Retrieve names of key variables |
| return_desired_format | Return a file name with the requested format |
| run_weighted_atkinson | Compute Weighted Atkinson Across a List of Data Frames |
| run_weighted_count | Compute (weighted) counts or percentages from a list of data... |
| run_weighted_gini | Compute Weighted Gini Index Across a List of Data Frames |
| run_weighted_mean | Compute Weighted Mean Across a List of Data Frames (with... |
| run_weighted_percentiles | Compute Weighted Percentiles cross a List of Data Frames... |
| run_weighted_poverty_gap_index | Compute the Poverty Gap Index |
| run_weighted_poverty_shortfall | Compute the Weighted Poverty Gap (Shortfall) |
| run_weighted_ratios | Compute Percentile Ratios |
| run_weighted_relative_poverty | Compute Relative Poverty Rate |
| set_lissy_attributes | Set lissy attributes |
| sort_lissy_list | Sort a list of lissy files |
| split_consecutive_values | Split vector into consecutive values |
| structure_to_plot | Transform Structured Data Lists into a Tidy Data Frame for... |
| testDateTime | Test if a value is a date-time object |
| transform_adjust_by_lisppp | Adjust aggregates by LIS PPPs |
| transform_equivalise | Equivalise by number of household members. |
| transform_equivalise_oecd | Equivalise with the OECD scale |
| transform_false_zeros_to_na | Recode zeros into missing values if all values are zero |
| transform_filter_age | Filter a sample by age |
| transform_negative_values_to_zero | Recode negative values to zero |
| transform_restrict_age | Filter a variable by age |
| transform_restrict_to_household_heads | Filter a variable for household heads |
| transform_top_code_with_iqr | Apply top or bottom coding with log IQR |
| transform_weight_by_hh_size | Multiply by household size |
| transform_zeros_to_na | Recodes zeros into missing values |
| us14_h_lis | Sample Household-Level LIS Dataset - US 2014 |
| us14_p_lis | Sample Individual-Level LIS Dataset - US 2014 |
| us16_h_lis | Sample Household-Level LIS Dataset - US 2016 |
| us16_h_lws | Sample Household-Level LWS Dataset - US 2016 |
| us16_p_lis | Sample Individual-Level LIS Dataset - US 2016 |
| us16_p_lws | Sample Individual-Level LWS Dataset - US 2016 |
| us18_h_lis | Sample Household-Level LIS Dataset - US 2018 |
| us18_p_lis | Sample Individual-Level LIS Dataset - US 2018 |
| us19_h_lws | Sample Household-Level LWS Dataset - US 2019 |
| us19_p_lws | Sample Individual-Level LWS Dataset - US 2019 |
| value_label_c_data | Value Labels for Country-Specific Variables in LIS and LWS... |
| variable_country_specific_categories | Retrieve the categories of a country-specific variable in... |
| variable_exists | Inspect whether a given variable contains more than just... |
| variable_has_note | Verify if a given variable has a note, for a selected group... |
| variable_labels | Inspect the Labels of LIS and LWS variables |
| wtd.quantile | Weighted statistical Estimates |
