Skip to content

Commit

Permalink
spellcheck changes
Browse files Browse the repository at this point in the history
  • Loading branch information
MartinHinz committed Jul 5, 2021
1 parent 9ae0aa6 commit 8d9e407
Show file tree
Hide file tree
Showing 9 changed files with 18 additions and 18 deletions.
6 changes: 3 additions & 3 deletions R/parsing_functions.R
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ oxcal_Sum <- function(oxcal_string, name = "Sum") {
#'
#' Phase takes a set of R_Dates as vectors, and returns
#' a bit of oxcal code that can be used to feed it into oxcal.
#' In this code the R_Dates are encapsuled in an OxCal Phases, one Phase for each string.
#' In this code the R_Dates are encapsulated in an OxCal Phases, one Phase for each string.
#' For details concerning the Oxcal simulation please consult the help page of Oxcal.
#'
#' @param r_dates_strings a vector containing strings of OxCal code, usually consisting of R_Date commands, but any other code strings might be used that can be interpreted by OxCal within a Phase
Expand Down Expand Up @@ -116,7 +116,7 @@ Boundary <- function(names) {
#'
#' Sequence takes a set of Phases or R_Dates as vectors, and returns
#' a bit of oxcal code that can be used to feed it into OxCal.
#' In this code the Phases and/or R_Dates are encapsuled in an OxCal Phases, one Phase for each string.
#' In this code the Phases and/or R_Dates are encapsulated in an OxCal Phases, one Phase for each string.
#' For details concerning the Oxcal simulation please consult the help page of Oxcal.
#'
#' @param sequence_elements a vector containing strings of OxCal code, usually consisting of Phase or R_Date commands, but any other code strings might be used that can be interpreted by OxCal within a Sequence
Expand All @@ -133,7 +133,7 @@ Sequence <- function(sequence_elements, names='') {
#'
#' wrap_in_boundaries takes a set of Phases or R_Dates as vectors, and returns
#' a bit of oxcal code that can be used to feed it into OxCal.
#' In this code the Phases and/or R_Dates are interleaved and wraped in OxCal Boundaries, the number of Boundaries is equal to the number of strings + 1.
#' In this code the Phases and/or R_Dates are interleaved and wrapped in OxCal Boundaries, the number of Boundaries is equal to the number of strings + 1.
#' The resulting string starts with a boundary, than the OxCal strings from the vector are interleaved with Boundary commands.
#' For details concerning the Oxcal simulation please consult the help page of Oxcal.
#'
Expand Down
8 changes: 4 additions & 4 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -25,11 +25,11 @@ knitr::opts_chunk$set(
`oxcAAR` (previously named `roxcal`) is a collection of functions that can be used
to execute [OxCal](https://c14.arch.ox.ac.uk) from within R.

Please note that there is a [`roxcal` package](https://github.com/gavinsimpson/roxcal) package on Github, created by [Gavin Simpson](https://github.com/gavinsimpson). If you just need to import OxCal result files, you may consider using his package.
Please note that there is a [`roxcal` package](https://github.com/gavinsimpson/roxcal) package on GitHub, created by [Gavin Simpson](https://github.com/gavinsimpson). If you just need to import OxCal result files, you may consider using his package.

## Licence
## License

`oxcAAR` is released under the [GNU General Public Licence, version 2](https://www.R-project.org/Licenses/GPL-2). Comments and feedback are welcome, as are code contributions.
`oxcAAR` is released under the [GNU General Public License, version 2](https://www.R-project.org/Licenses/GPL-2). Comments and feedback are welcome, as are code contributions.

## Installation

Expand All @@ -51,6 +51,6 @@ To get started, just run:
quickSetupOxcal()
```

This will download and unzip [Oxcal](https://c14.arch.ox.ac.uk/oxcal.html) into tempdir(). You can change the destination path of Oxcal by setting the `path` parameter. Please make sure that you have a working internet connection when attempting to use this function!
This will download and unzip [OxCal](https://c14.arch.ox.ac.uk/oxcal.html) into tempdir(). You can change the destination path of OxCal by setting the `path` parameter. Please make sure that you have a working internet connection when attempting to use this function!

Afterwards you can start calibrating your dates. Check the [Vignette](vignettes/basic-usage.Rmd) to learn how to do this.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,13 @@ Status](https://img.shields.io/codecov/c/github/ISAAKiel/oxcAAR/master.svg)](htt
can be used to execute [OxCal](https://c14.arch.ox.ac.uk) from within R.

Please note that there is a [`roxcal`
package](https://github.com/gavinsimpson/roxcal) package on Github,
package](https://github.com/gavinsimpson/roxcal) package on GitHub,
created by [Gavin Simpson](https://github.com/gavinsimpson). If you just
need to import OxCal result files, you may consider using his package.

## Licence
## License

`oxcAAR` is released under the [GNU General Public Licence, version
`oxcAAR` is released under the [GNU General Public License, version
2](https://www.R-project.org/Licenses/GPL-2). Comments and feedback are
welcome, as are code contributions.

Expand All @@ -42,8 +42,8 @@ To get started, just run:
quickSetupOxcal()

This will download and unzip
[Oxcal](https://c14.arch.ox.ac.uk/oxcal.html) into tempdir(). You can
change the destination path of Oxcal by setting the `path` parameter.
[OxCal](https://c14.arch.ox.ac.uk/oxcal.html) into tempdir(). You can
change the destination path of OxCal by setting the `path` parameter.
Please make sure that you have a working internet connection when
attempting to use this function!

Expand Down
2 changes: 1 addition & 1 deletion basic-usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -196,7 +196,7 @@ plot(my_simulated_dates)
Simulate Sum Calibration
------------------------

This package was originally intended to support a series of articles dealing with the investigation of sum calibration. That is why a function is implemented to simulate sum calibration. You can use it to simulate a series of <sup>14</sup>C dates and explore the sum calibrated results. You can specify the beginning and end of the time span that should be used for the simulation (in calender years), the number of <sup>14</sup>C dates that should be simulated, their standard deviation either as vector of length n or as one number for all dates, and the type of distribution that should be used (either equally spaced in time, or random uniform). The result is again of class `oxcAARCalibratedDate`, so you can access the raw probabilities for further analysis.
This package was originally intended to support a series of articles dealing with the investigation of sum calibration. That is why a function is implemented to simulate sum calibration. You can use it to simulate a series of <sup>14</sup>C dates and explore the sum calibrated results. You can specify the beginning and end of the time span that should be used for the simulation (in calendar years), the number of <sup>14</sup>C dates that should be simulated, their standard deviation either as vector of length n or as one number for all dates, and the type of distribution that should be used (either equally spaced in time, or random uniform). The result is again of class `oxcAARCalibratedDate`, so you can access the raw probabilities for further analysis.

``` r
my_sum_sim<-oxcalSumSim(
Expand Down
2 changes: 1 addition & 1 deletion man/Phase.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/Sequence.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/wrap_in_boundaries.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion vignettes/basic-usage.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ plot(my_simulated_dates)

## Simulate Sum Calibration

This package was originally intended to support a series of articles dealing with the investigation of sum calibration. This is why a function is implemented to simulate sum calibration. You can use it to simulate a series of <sup>14</sup>C dates and explore the sum calibrated results. You can specify the beginning and end of the time span that should be used for the simulation (in calender years), the number of <sup>14</sup>C dates that should be simulated, their standard deviation, either as vector of length n or as one number for all dates, and the type of distribution that should be used (either equally spaced in time, or random uniform).
This package was originally intended to support a series of articles dealing with the investigation of sum calibration. This is why a function is implemented to simulate sum calibration. You can use it to simulate a series of <sup>14</sup>C dates and explore the sum calibrated results. You can specify the beginning and end of the time span that should be used for the simulation (in calendar years), the number of <sup>14</sup>C dates that should be simulated, their standard deviation, either as vector of length n or as one number for all dates, and the type of distribution that should be used (either equally spaced in time, or random uniform).
The result is again of class `oxcAARCalibratedDate` so you can access the raw probabilities for further analysis.

```{r,fig.width=7,fig.height=4}
Expand Down
2 changes: 1 addition & 1 deletion vignettes/basic-usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -196,7 +196,7 @@ plot(my_simulated_dates)
Simulate Sum Calibration
------------------------

This package was originally intended to support a series of articles dealing with the investigation of sum calibration. That is why a function is implemented to simulate sum calibration. You can use it to simulate a series of <sup>14</sup>C dates and explore the sum calibrated results. You can specify the beginning and end of the time span that should be used for the simulation (in calender years), the number of <sup>14</sup>C dates that should be simulated, their standard deviation either as vector of length n or as one number for all dates, and the type of distribution that should be used (either equally spaced in time, or random uniform). The result is again of class `oxcAARCalibratedDate`, so you can access the raw probabilities for further analysis.
This package was originally intended to support a series of articles dealing with the investigation of sum calibration. That is why a function is implemented to simulate sum calibration. You can use it to simulate a series of <sup>14</sup>C dates and explore the sum calibrated results. You can specify the beginning and end of the time span that should be used for the simulation (in calendar years), the number of <sup>14</sup>C dates that should be simulated, their standard deviation either as vector of length n or as one number for all dates, and the type of distribution that should be used (either equally spaced in time, or random uniform). The result is again of class `oxcAARCalibratedDate`, so you can access the raw probabilities for further analysis.

``` r
my_sum_sim<-oxcalSumSim(
Expand Down

0 comments on commit 8d9e407

Please sign in to comment.