Man pages for shirewoman2/Consultancy
Standardized tools for using R within the Simcyp Consultancy Team

addObsPointsINTERNAL PACKAGE USE: Add observed data points to a...
add_simsAdd simulations to an R object
AllCompoundsAll possible compound IDs, suffixes, etc.
AllExpDetailsAll possible experimental details for 'extractExpDetails'
AllPKParametersAll possible PK parameters for 'extractPK' (version for...
AllStatsAll names for statistics used in the package
AllTissuesAll possible tissues and tissue subtypes
annotateDetailsAnnotate Simcyp Simulator experimental details
blueGreensCreate a vector of blues fading into greens
bluesCreate a vector of blues
BufForestDataExample output from 'extractForestData'
BufForestData_20mgExample output from 'extractForestData'
BufObsForestDataExample observed PK data for working with 'forest_plot'
calc_dosenumberCalculate the dose number for each time in a set of...
calcKiCalculate the Ki of an inhibitor with the Cheng-Prusoff...
calc_PKCalculate basic PK parameters for concentration-time data
calc_PK_ratiosCalculate the ratio of PK parameters between two simulations
calc_PK_ratios_multCalculate the ratio of PK parameters between multiple pairs...
centerBinCut a set of numeric data into bins based on the middle value...
change_xml_pathSet the user name in the path of observed data overlay XML...
chartreuseCreate a vector of yellow-greens
check_doseintCheck whether an AUC interval ends on a dosing interval
check_file_nameChecks a file name for naming standards using the criteria...
check_include_dose_numINTERNAL PACKAGE USE ONLY. Check on whether to include the...
check_simulator_initializedcheck whether the Simcyp Simulator has been initialized
checkSSCreate a graph of simulated concentrations to check for...
clean_obs_dataTidy up messy observed concentration-time data. UNDER...
confIntCalculate the X percent confidence interval
convert_conc_unitsConvert the concentration units in a data.frame of...
convert_days_to_hoursConvert times in days to times in hours
convert_time_unitsConvert the time units in a data.frame of concentration-time...
convert_unitsConvert concentration and time units as needed
countWordsCount the number of words in each item in a vector or list
create_dosesCreate a csv file of dosing rows for XML files
create_doses_from_fileCreate a csv file of dosing rows for XML files using a study...
ct_plotConcentration-time plots to match Consultancy template
ct_plot_1stlastMake concentration-time plots of the 1st and last doses only
ct_plot3Concentration-time plots of the full time range, first dose,...
ct_plot_multMake graphs for multiple Simulator output files at once
ct_plot_obsPlot observed concentration-time data
ct_plot_overlayOverlay multiple data sets onto a single concentration-time...
ct_x_axisSet up x axis in a conc-time plot
ct_y_axisSet up y axis in a conc-time plot
cutNumericCut numeric data into bins with vector output
CYP3A4_gutCYP3A4 enzyme-abundance data in the gut
CYP3A4_liverCYP3A4 enzyme-abundance data in the liver
dateConvConvert dates from numbers to Date
deannotateDetailsDe-annotate a data.frame of experimental details that was...
demog_plot_simMake plots for comparing populations across simulations
demog_plot_SOMake a set of plots showing the demographics used in a set of...
demog_tableMake a table of demographics for a set of simulations
detect_file_timestampFigure out what date/time stamps on Excel results files would...
determine_myperpetratorDetermine the (optionally pretty) name of all perpetrators...
difftime_simCalculate the time difference between two times formatted as...
dissolution_profile_plotMake a graph of the dissolution profiles of a compound
dosing_regimen_plotPlot the dosing regimens used in simulations
draft_methods_textCreate some draft text to insert into the methods section of...
draft_results_textCreate some draft text to insert into the results section of...
draft_text_multCreate some draft text to insert into the methods and results...
eCT_harmonizeHarmonize the compound names on sim_data_xl to made finding...
eCT_pulldataPull the appropriate data from the harmonized Excel tab
eCT_readxlRead into memory an Excel sheet for extracting conc-time...
elimFitCalculate the elimination rate(s) for a concentration-time...
enz_plotPlots of enzyme abundance changes over time to match...
enz_plot_overlayOverlay multiple data sets onto a single enzyme-abundance...
ExpDetailDefinitionsAll possible experimental details for 'extractExpDetails'
ExpDetailDefinitions_DiscoveryAll possible experimental details for 'extractExpDetails'
ExpDetailListItemsThe names of the items that should be in the list output from...
extractAUCXtabFOR INTERNAL USE ONLY: Extract PK data from a generic AUC...
extractConcTimeExtract concentration-time data from a simulator output Excel...
extractConcTime_DBExtract concentration-time data from a Simcyp Simulator...
extractConcTime_multPull concentration-time data from multiple Simcyp Simulator...
extractDemogExtract simulated demographic data from the "Demographic...
extractEnzAbundExtract enzyme abundance data from a simulator output Excel...
extractEnzAbund_multPull enzyme-abundance data from multiple Simcyp Simulator...
extractExpDetailsExtract details about the experimental design
extractExpDetails_DBExtract simulation experimental details from a database file
extractExpDetails_multExtract experimental details for multiple files at once
extractExpDetails_XMLExtract experimental details for multiple Simcyp Simulator...
extractFmFeExtract fm and fe valuesthat change with time from a...
extractForestDataExtract pertinent data from Simulator output files for...
extract_fuExtract fu,plasma values that change with time from a...
extractObsConcTimeExtract observed concentration-time data from an Excel file
extractObsConcTime_multExtract observed concentration-time data from multiple Excel...
extractObsConcTime_xlsxINTERNAL - Extract observed conc-time data from an xlsx file
extractObsConcTime_XMLINTERNAL - Extract observed conc-time data from an xml file
extractPKExtract PK data for specific parameters from a simulator...
extractPK_DBExtract PK from a Simcyp Simulator database file
filter_simsSelectively include or omit specific simulations from an R...
fm_plotCreate a plot of how fm or fe values change over time
fm_treemapFor comparing fm values, make a treemap as opposed to the...
forest_plotCreate a forest plot
format_obs_for_XMLFormat generic observed data for making an XML overlay file
format_scriptsFormat common PBPK model parameters to have appropriate...
formatTable_SimcypFormat tables according to Simcyp Consultancy Team...
format_table_simpleFormat a table rather simply to look nice in a Word file
get_obs_PKINTERNAL - For use w/pksummary_table.
getReferencesPull references from a "DataRec" folder
gm_confCalculate the geometric X percent confidence interval
gm_CVCalculate the geometric coefficient of variation (CV)
gm_meanCalculate the geometric mean
gm_sdCalculate the geometric standard deviation
graph_boxplotMake boxplots or boxplots overlaid with individual points
greensCreate a vector of greens
green_to_redMake a vector of colors that match the "green to red" option...
guess_col_widthsINTERNAL guess appropriate column widths
harmonize_detailsFOR INTERNAL PACKAGE USE. Take as input an existing...
harmonize_dosingINTERNAL - Harmonize the dosing information for an object...
harmonize_PK_namesHarmonize user input for PK parameters
IndDataExample induction data for use with the inductFit function
inductFitFit induction data to calculate EC50, Emax, and/or slope
insert_copyrightInsert the standard Certara UK Limited copyright box that...
launch_package_indexLaunch the shiny app for showing an annotated index of what...
list_interactionsFind all the possible drug-drug interactions between...
LMVctPlasma concentration-time data for a simulation of letermovir
log10_breaksCreate nice breaks for graphs of log-transformed data
make_color_setCreate a set of colors for use in graphs
make_ct_captionINTERNAL - make caption for conc-time plots
make_example_PK_inputExamples for supplying PK parameters to the pk_table or...
make_gmr_highlight_keyMake a key for highlighted geometric mean ratios for DDIs in...
make_log_breaksMake pretty breaks and labels for a log axis
make_Simcyp_inputs_tableSummarize a PBPK model using parameters pulled from...
make_simulation_directoryMake a directory of simulations indicating which simulation...
make_so_highlight_keyMake a key for highlighted S/O values in a table or graph
make_table_annotationsMake table headings and captions for use internally when...
make_text_legosINTERNAL - Assemble pieces of text for headings, captions and...
make_trial_design_tableCreate a table describing a simulation trial design.
make_xml_path_mineMake the user name in the path of observed data overlay XML...
match_obs_to_simMatch observed concentration-time data to the correct...
MDZctPlasma concentration-time data for multiple simulations of...
MDZdetailsExample output from 'extractExpDetails_mult'
MDZ_KetoPlasma concentration-time data for midazolam and ketoconazole
move_asterisksINTERNAL - Move asterisks around so that you can put...
noncompAUCCalculate the AUC using the trapezoidal rule
ObsColNamesColumn names for observed concentration-time data by...
ObsDVoptionsObserved data DV options
OntogenyEquationsEquations used for calculating drug-metabolizing enzyme and...
ontogeny_plotGraph the ontogenies of drug-metabolizing enzymes and...
pdf_to_csvConvert a page from a pdf file to a csv file
PKexamplesExamples for specifying PK parameters with pk_table
PKexamples_ratiosExamples for specifying PK parameters with calc_PK_ratios and...
PKexpressionsFormatted PK parameter labels for use with graphs
PKParameterDefinitionsAll possible PK parameters for 'extractPK'
pksummary_multMake a summary PK table for a report or slide deck - THIS...
pksummary_tableMake a summary PK table for a report or slide deck - THIS...
pk_tableMake tables of PK values from Simulator output Excel files
pk_table_subfunSubfunction for pk_table. FOR INTERNAL PACKAGE USE.
prettify_column_namesConvert the column names in a table of PK parameters into...
prettify_compound_nameMake a compound name prettier and more human readable
purplesCreate a vector of purples
qc_simsMake an Excel file for QCing simulations
rainbowCreate a vector of a rainbow of colors
recalc_PKRecalculate the PK for specific concentration-time profiles...
redsCreate a vector of reds
release_profile_plotMake a graph of the release profiles of a compound
remove_file_timestampRemove date/time stamps from Excel results files created by...
renameStatsINTERNAL: Rename the statistics listed in Simulator output to...
ReportInputFormReport input forms to be used in conjunction with...
round_consultancyRounding to match the SimcypConsultancy report template...
round_downRound a number or vector of numbers up or down to nice...
round_down_unitRound a number or vector of numbers up or down to nice...
round_optINTERNAL: Rounding function
round_unitRound a number or vector of numbers up or down to nice...
round_upRound a number or vector of numbers up or down to nice...
round_up_niceRound a number or vector of numbers up or down to nice...
round_up_unitRound a number or vector of numbers up or down to nice...
runShinyLaunch the shiny app for making PK summary tables and...
save_table_to_ExcelSave a data.frame or tibble to Excel with some standard...
save_table_to_WordSave a bespoke PK table to Word using the pk_table rmarkdown...
scale_x_timeAutomatically scale a ggplot graph x axis for time
scale_x_time_setupGet the information needed to automatically scale a ggplot...
sensitivity_plotMake graphs of sensitivity analysis results
set_aesthetSet up certain aesthetics a conc-time plot
set_boundary_colorsINTERNAL: Create a set of boundary colors based on the color...
show_code_exampleIN PROGRESS - Show some examples for the code to use for...
SimcypColorsSimcyp colors used in the PowerPoint template
SOdataExample simulated vs. observed PK data for use with the...
so_graphGraph of simulated vs. observed PK
sort_simsSort the simulation file order in an object
str_commaCollapse a vector of character strings into one readable...
theme_consultancyApply the standard Consultancy Team graphing styles to your...
tidy_input_PKTidy input PK data as needed
tidy_PKparameters_namesINTERNAL USE. tidy the column names of PKparameters supplied...
tidyPopTidying Simcyp simulator population names for reports, etc.
timeConvConvert times from numbers to POSIXct
trapRuleCalculate the AUC using the trapezoidal rule
trial_means_plotMake graphs comparing the center statistic and variability in...
wrapnINTERNAL PACKAGE USE. Wrap warning text and add a carriage...
yellow_to_redMake a vector of colors that match the "yellow to red" option...
shirewoman2/Consultancy documentation built on Feb. 18, 2025, 10 p.m.