diff --git a/pkgdown.yml b/pkgdown.yml index 4d11eb70..8d80b09b 100644 --- a/pkgdown.yml +++ b/pkgdown.yml @@ -6,7 +6,7 @@ articles: strategies: strategies.html utilities: utilities.html xoanda: xoanda.html -last_built: 2024-09-11T22:33Z +last_built: 2024-09-11T23:10Z urls: reference: https://shikokuchuo.net/ichimoku/reference article: https://shikokuchuo.net/ichimoku/articles diff --git a/reference/archive.html b/reference/archive.html index 5743c703..b467a27e 100644 --- a/reference/archive.html +++ b/reference/archive.html @@ -121,11 +121,11 @@

Examplesfile <- tempfile() archive(cloud, file) -#> Archive written to '/tmp/RtmpK9knIu/file16dc22295b3a' +#> Archive written to '/tmp/Rtmp18QPtL/file16f436b7b92d' #> SHA256: f04ccb6b8869372733acb7ad07d468624e58b1b8ee9d6a715ab13e698fd1373b restored <- archive(file) -#> Archive read from '/tmp/RtmpK9knIu/file16dc22295b3a' +#> Archive read from '/tmp/Rtmp18QPtL/file16f436b7b92d' #> Data verified by SHA256: f04ccb6b8869372733acb7ad07d468624e58b1b8ee9d6a715ab13e698fd1373b unlink(file) diff --git a/reference/as.data.frame.ichimoku.html b/reference/as.data.frame.ichimoku.html index b0726291..16a7e87e 100644 --- a/reference/as.data.frame.ichimoku.html +++ b/reference/as.data.frame.ichimoku.html @@ -61,7 +61,7 @@

Argumentsx -

an object of class 'ichimoku'.

+

an object of class ‘ichimoku’.

row.names
@@ -83,14 +83,14 @@

Arguments

Value

-

A 'data.frame' object. The ichimoku object index is preserved as the - first column with header 'index'.

+

A ‘data.frame’ object. The ichimoku object index is preserved + as the first column with header ‘index’.

Details

This function is an S3 method for the generic function - as.data.frame() for class 'ichimoku'. It can be invoked by calling - as.data.frame(x) on an object 'x' of class 'ichimoku'.

+ as.data.frame() for class ‘ichimoku’. It can be invoked by calling + as.data.frame(x) on an object ‘x’ of class ‘ichimoku’.

diff --git a/reference/autoplot.ichimoku.html b/reference/autoplot.ichimoku.html index 3978038e..22dca928 100644 --- a/reference/autoplot.ichimoku.html +++ b/reference/autoplot.ichimoku.html @@ -76,8 +76,8 @@

Argumentswindow

(optional) a date-time window to subset the plot, in ISO-8601 -compatible range strings of the format used for 'xts' objects, for example -"2020-02-15/2020-08-15" or "2020-02-15/", "/2020-08" or "2020-07".

+compatible range strings of the format used for ‘xts’ objects, for +example "2020-02-15/2020-08-15" or "2020-02-15/", "/2020-08" or "2020-07".

ticker
@@ -87,13 +87,15 @@

Argumentssubtitle -

(optional) specify a subtitle to display under the chart title.

+

(optional) specify a subtitle to display under the chart +title.

theme
-

[default 'classic'] with further choices of 'dark', 'mono', -'noguchi', 'okabe-ito' or 'solarized'. Alternatively, supply a vector -of 12 colour values (hex codes or names) as a user-defined theme.

+

[default 'classic'] with further choices of ‘dark’, +‘mono’, ‘noguchi’, ‘okabe-ito’ or ‘solarized’. +Alternatively, supply a vector of 12 colour values (hex codes or names) +as a user-defined theme.

strat
diff --git a/reference/autostrat.html b/reference/autostrat.html index 79843d5f..7d860a88 100644 --- a/reference/autostrat.html +++ b/reference/autostrat.html @@ -93,17 +93,17 @@

Arguments

Value

-

Returned invisibly, a list of 'n' ichimoku objects containing - strategies, with attributes 'logret' (a vector of cumulative log returns - for all strategies) and 'summary' (a matrix of summaries for the top 'n' - strategies).

+

Returned invisibly, a list of ‘n’ ichimoku objects containing + strategies, with attributes ‘logret’ (a vector of cumulative log + returns for all strategies) and ‘summary’ (a matrix of summaries + for the top ‘n’ strategies).

In addition, the strategy summaries are printed to the console.

Details

Ichimoku objects for each strategy are returned as a list. The cumulative log returns for all strategies as well as the summaries for - the top 'n' strategies are saved as attributes to the list. This + the top ‘n’ strategies are saved as attributes to the list. This information may be retrieved by using look on the returned list.

Each individual ichimoku object may be accessed via its position in the diff --git a/reference/coredata.ichimoku.html b/reference/coredata.ichimoku.html index 6abab473..62287815 100644 --- a/reference/coredata.ichimoku.html +++ b/reference/coredata.ichimoku.html @@ -61,13 +61,14 @@

Argumentsx -

an object of class 'ichimoku'.

+

an object of class ‘ichimoku’.

fmt

(optional) set to TRUE to retain the index as row names of the -returned matrix, or a character string passed on to the 'format' argument -of format.POSIXct() to format these values in a specific way.

+returned matrix, or a character string passed on to the ‘format’ +argument of format.POSIXct() to format these values in a specific +way.

...
@@ -77,14 +78,14 @@

Arguments

Value

A numeric matrix containing the ichimoku object data, stripped of the - index unless 'fmt' is specified in which case the index will be retained - as character values in the matrix row names.

+ index unless ‘fmt’ is specified in which case the index will be + retained as character values in the matrix row names.

Details

This function is an S3 method for the generic function coredata() - for class 'ichimoku'. It can be invoked by calling coredata(x) on an - object 'x' of class 'ichimoku'.

+ for class ‘ichimoku’. It can be invoked by calling coredata(x) on + an object ‘x’ of class ‘ichimoku’.

diff --git a/reference/df_append.html b/reference/df_append.html index 38b04e9e..39b94bad 100644 --- a/reference/df_append.html +++ b/reference/df_append.html @@ -79,24 +79,27 @@

Argumentskeep.attr -

[default 'timestamp'] name of an attribute in 'new' to -retain, if present, provided as a character string.

+

[default 'timestamp'] name of an attribute in ‘new’ +to retain, if present, provided as a character string.

Value

A data.frame of the existing data appended with the new data. If the - data in 'new' contains data with the same value for the key column as 'old', - the data in 'new' will overwrite the data in 'old'.

-

If the attribute specified by 'keep.attr' is present in 'new', this is - retained. All other non-required attributes are dropped.

+ data in ‘new’ contains data with the same value for the key column + as ‘old’, the data in ‘new’ will overwrite the data in + ‘old’.

+

If the attribute specified by ‘keep.attr’ is present in + ‘new’, this is retained. All other non-required attributes are + dropped.

Details

-

Can be used to update price dataframes retrieved by oanda. - The function is designed to update existing data with new values as they - become available. As opposed to df_merge, the data in 'new' - will overwrite the data in 'old' rather than create duplicates.

+

Can be used to update price dataframes retrieved by + oanda. The function is designed to update existing data + with new values as they become available. As opposed to + df_merge, the data in ‘new’ will overwrite the data + in ‘old’ rather than create duplicates.

diff --git a/reference/df_merge.html b/reference/df_merge.html index 54aaa18d..30d8960d 100644 --- a/reference/df_merge.html +++ b/reference/df_merge.html @@ -81,11 +81,11 @@

Value

Details

Can be used to join price dataframes retrieved by oanda. The function is designed to join complete historical data. If the data to - be merged contains data with incomplete periods, all entries are preserved - rather than updated. If incomplete periods are detected within the data, - a warning is issued, and the resulting dataframe should be manually checked - in case it contains unwanted duplicates. Use df_append for - updating dataframes with new values.

+ be merged contains data with incomplete periods, all entries are + preserved rather than updated. If incomplete periods are detected within + the data, a warning is issued, and the resulting dataframe should be + manually checked in case it contains unwanted duplicates. Use + df_append for updating dataframes with new values.

diff --git a/reference/dot-ichimoku.html b/reference/dot-ichimoku.html index 599f1a43..b59db593 100644 --- a/reference/dot-ichimoku.html +++ b/reference/dot-ichimoku.html @@ -89,19 +89,21 @@

Arguments... -

additional arguments, for instance 'holidays', passed along to -tradingDays for calculating the future cloud on daily data.

+

additional arguments, for instance ‘holidays’, passed along +to tradingDays for calculating the future cloud on daily +data.

Value

-

An ichimoku object with S3 classes of 'ichimoku', 'xts' and 'zoo'.

+

An ichimoku object with S3 classes of ‘ichimoku’, ‘xts’ + and ‘zoo’.

Details

A faster version of ichimoku which can be used when the data is a dataframe in the prescribed format. Does not support the - argument 'keep.data'.

+ argument ‘keep.data’.