From 031c7601967eb9eeafd27020a61b683e938e297f Mon Sep 17 00:00:00 2001 From: Ashesh Rambachan Date: Fri, 23 Feb 2024 16:58:50 -0500 Subject: [PATCH] Update spacing in Rd file for CRAN submission --- man/computeConditionalCS_DeltaSDRMM.Rd | 9 +++++++-- man/constructOriginalCS.Rd | 3 ++- man/createEventStudyPlot.Rd | 3 ++- man/createSensitivityPlot.Rd | 7 ++++--- man/createSensitivityPlot_relativeMagnitudes.Rd | 17 +++++++++-------- 5 files changed, 24 insertions(+), 15 deletions(-) diff --git a/man/computeConditionalCS_DeltaSDRMM.Rd b/man/computeConditionalCS_DeltaSDRMM.Rd index 5fc75bf..e2d104b 100644 --- a/man/computeConditionalCS_DeltaSDRMM.Rd +++ b/man/computeConditionalCS_DeltaSDRMM.Rd @@ -5,7 +5,11 @@ Computes conditional and hybridized confidence set for Delta = Delta^{SDRMM}(Mbar). } \description{ -Computes the conditional confidence set and hybridized confidence set for Delta = Delta^{SDRMM}(Mbar). The set Delta^{SDRMM}(Mbar) adds an additional shape restriction to Delta^{SDRM}(Mbar) that restricts the underlying trend to be monotone. It may either be increasing (delta_t >= delta_{t-1}) or decreasing (delta_t <= delta_{t-1}). +Computes the conditional confidence set and hybridized confidence set +for Delta = Delta^{SDRMM}(Mbar). The set Delta^{SDRMM}(Mbar) adds an +additional shape restriction to Delta^{SDRM}(Mbar) that restricts the +underlying trend to be monotone. It may either be increasing +(delta_t >= delta_{t-1}) or decreasing (delta_t <= delta_{t-1}). } \usage{ computeConditionalCS_DeltaSDRMM(betahat, sigma, numPrePeriods, numPostPeriods, @@ -13,7 +17,8 @@ computeConditionalCS_DeltaSDRMM(betahat, sigma, numPrePeriods, numPostPeriods, size = numPostPeriods), Mbar = 0, alpha = 0.05, hybrid_flag = "LF", hybrid_kappa = alpha/10, returnLength = FALSE, - postPeriodMomentsOnly = TRUE, monotonicityDirection = "increasing", + postPeriodMomentsOnly = TRUE, + monotonicityDirection = "increasing", gridPoints=10^3, grid.ub = NA, grid.lb = NA) } %- maybe also 'usage' for other objects documented here. diff --git a/man/constructOriginalCS.Rd b/man/constructOriginalCS.Rd index 16218ab..9bb833a 100644 --- a/man/constructOriginalCS.Rd +++ b/man/constructOriginalCS.Rd @@ -50,7 +50,8 @@ Returns a dataframe with columns } } \examples{ - # Simple use case; for more detailed examples, see + # Simple use case; for more detailed examples, + # see constructOriginalCS(betahat = BCdata_EventStudy$betahat, sigma = BCdata_EventStudy$sigma, numPrePeriods = length(BCdata_EventStudy$prePeriodIndices), diff --git a/man/createEventStudyPlot.Rd b/man/createEventStudyPlot.Rd index 24f864d..1c99241 100644 --- a/man/createEventStudyPlot.Rd +++ b/man/createEventStudyPlot.Rd @@ -52,7 +52,8 @@ Rambachan, Ashesh and Jonathan Roth. "An Honest Approach to Parallel Trends." 20 Ashesh Rambachan } \examples{ - # Simple use case; for more detailed examples, see + # Simple use case; for more detailed examples, + # see createEventStudyPlot(betahat = BCdata_EventStudy$betahat, sigma = BCdata_EventStudy$sigma, diff --git a/man/createSensitivityPlot.Rd b/man/createSensitivityPlot.Rd index 40ec49f..7930070 100644 --- a/man/createSensitivityPlot.Rd +++ b/man/createSensitivityPlot.Rd @@ -39,14 +39,15 @@ Returns ggplot object of the sensitivity plot. Ashesh Rambachan } \examples{ - # Simple use case; for more detailed examples, see - robustResults <- + # Simple use case; for more detailed examples, + # see + robustResults <- createSensitivityResults(betahat = BCdata_EventStudy$betahat, sigma = BCdata_EventStudy$sigma, numPrePeriods = length(BCdata_EventStudy$prePeriodIndices), numPostPeriods = length(BCdata_EventStudy$postPeriodIndices), alpha = 0.05) - originalResults <- + originalResults <- constructOriginalCS(betahat = BCdata_EventStudy$betahat, sigma = BCdata_EventStudy$sigma, numPrePeriods = length(BCdata_EventStudy$prePeriodIndices), diff --git a/man/createSensitivityPlot_relativeMagnitudes.Rd b/man/createSensitivityPlot_relativeMagnitudes.Rd index 378f143..6f5805a 100644 --- a/man/createSensitivityPlot_relativeMagnitudes.Rd +++ b/man/createSensitivityPlot_relativeMagnitudes.Rd @@ -40,14 +40,15 @@ Returns ggplot object of the sensitivity plot. Ashesh Rambachan } \examples{ - # Simple use case; for more detailed examples, see - robustResults <- - createSensitivityResults_relativeMagnitudes(betahat = BCdata_EventStudy$betahat, - sigma = BCdata_EventStudy$sigma, - numPrePeriods = length(BCdata_EventStudy$prePeriodIndices), - numPostPeriods = length(BCdata_EventStudy$postPeriodIndices), - alpha = 0.05) - originalResults <- + # Simple use case; for more detailed examples, + # see + robustResults <- createSensitivityResults_relativeMagnitudes( + betahat = BCdata_EventStudy$betahat, + sigma = BCdata_EventStudy$sigma, + numPrePeriods = length(BCdata_EventStudy$prePeriodIndices), + numPostPeriods = length(BCdata_EventStudy$postPeriodIndices), + alpha = 0.05) + originalResults <- constructOriginalCS(betahat = BCdata_EventStudy$betahat, sigma = BCdata_EventStudy$sigma, numPrePeriods = length(BCdata_EventStudy$prePeriodIndices),